@aepstore-dev/contracts 1.32.0 → 1.33.0

package/proto/users.proto

@@ -1,286 +1,411 @@
-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);
-
-    rpc CreateSubscription(SubscriptionRequest) returns (SubscriptionResponse);
-    rpc DeleteSubscription(SubscriptionRequest) returns (SubscriptionResponse);
-
-    rpc BanUser(BanUserRequest) returns (UserResponse);
-    rpc UnbanUser(UnbanUserRequest) returns (UserResponse);
-}
-
-// =================================================================
-// 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;
-    bool is_banned = 9;
-    string banned_until = 10; // ISO 8601, empty = permanent/none
-    string ban_reason = 11;
-}
-
-message BanUserRequest {
-    string admin_id = 1;
-    string user_id = 2;
-    string reason = 3;
-    string until = 4; // ISO 8601; empty = permanent ban
-}
-
-message UnbanUserRequest {
-    string admin_id = 1;
-    string user_id = 2;
-}
-
-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 ProductUser {
-    string id = 1;
-    string username = 2;
-    string avatar_url = 3;
-}
-
-message Category {
-    string id = 1;
-    string name = 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;
-    // profile-card preview fields
-    string preview = 7;
-    string final_price = 8;    // Decimal as string
-    string average_rating = 9; // number as string
-    string status = 10;
-    // Author of the product (same person as the profile owner, but echoed per
-    // product so cards can render the author independently).
-    ProductUser user = 11;
-    repeated Category categories = 12;
-}
-
-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;
-}
-
-// Compact public user card for subscriber/subscription lists — no email/ban data.
-message ProfileUser {
-    string id = 1;
-    string username = 2;
-    string avatar_url = 3;
-}
-
-// =================================================================
-// 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 ProfileUser subscriptions = 16;
-    repeated ProfileUser subscribers = 17;
-    bool is_owner = 18;
-    bool is_subscribed = 19; // viewer is subscribed to this profile (false when anonymous / self)
-}
-
-// =================================================================
-// 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;
-    string action = 4; // "grant" (default) | "revoke"
-}
-
-// =================================================================
-// 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 ProfileUser subscriptions = 3;
-    repeated ProfileUser subscribers = 4;
-    int32 total = 5;
-    int32 page = 6;
-    int32 limit = 7;
-}
-
-// =================================================================
-// Subscriptions
-// =================================================================
-
-message SubscriptionRequest {
-    string subscriber_id = 1; // the authenticated user performing the action
-    string target_id = 2;     // the user being (un)subscribed to/from
-}
-
-message SubscriptionResponse {
-    bool subscribed = 1;          // state after the call
-    int32 subscribers_count = 2;  // target's subscriber count after the call
-}
+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);
+
+    rpc CreateSubscription(SubscriptionRequest) returns (SubscriptionResponse);
+    rpc DeleteSubscription(SubscriptionRequest) returns (SubscriptionResponse);
+
+    rpc BanUser(BanUserRequest) returns (UserResponse);
+    rpc UnbanUser(UnbanUserRequest) returns (UserResponse);
+
+    // Premium (paid). State lives in users-service; payments-service handles
+    // money and calls ActivatePremium (internal) on completion.
+    rpc GetMyPremium(GetMyPremiumRequest) returns (PremiumStateResponse);
+    rpc SetPremiumAutoRenew(SetPremiumAutoRenewRequest) returns (PremiumStateResponse);
+    // Internal — InternalServiceGuard. Called by payments-service after a
+    // successful premium payment (balance or YooKassa webhook).
+    rpc ActivatePremium(ActivatePremiumRequest) returns (PremiumStateResponse);
+    // Internal — fast lookup for the commission engine in payments-service.
+    rpc IsPremiumActive(IsPremiumActiveRequest) returns (IsPremiumActiveResponse);
+
+    // Avatar borders (catalog + admin CRUD). Catalog read is public; mutations
+    // are admin only (gateway enforces with RolesGuard).
+    rpc ListAvatarBorders(ListAvatarBordersRequest) returns (ListAvatarBordersResponse);
+    rpc UpsertAvatarBorder(UpsertAvatarBorderRequest) returns (AvatarBorder);
+    rpc DeleteAvatarBorder(DeleteAvatarBorderRequest) returns (DeleteAvatarBorderResponse);
+}
+
+// =================================================================
+// 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;
+    bool is_banned = 9;
+    string banned_until = 10; // ISO 8601, empty = permanent/none
+    string ban_reason = 11;
+}
+
+message BanUserRequest {
+    string admin_id = 1;
+    string user_id = 2;
+    string reason = 3;
+    string until = 4; // ISO 8601; empty = permanent ban
+}
+
+message UnbanUserRequest {
+    string admin_id = 1;
+    string user_id = 2;
+}
+
+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 ProductUser {
+    string id = 1;
+    string username = 2;
+    string avatar_url = 3;
+}
+
+message Category {
+    string id = 1;
+    string name = 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;
+    // profile-card preview fields
+    string preview = 7;
+    string final_price = 8;    // Decimal as string
+    string average_rating = 9; // number as string
+    string status = 10;
+    // Author of the product (same person as the profile owner, but echoed per
+    // product so cards can render the author independently).
+    ProductUser user = 11;
+    repeated Category categories = 12;
+}
+
+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;
+}
+
+// Compact public user card for subscriber/subscription lists — no email/ban data.
+message ProfileUser {
+    string id = 1;
+    string username = 2;
+    string avatar_url = 3;
+}
+
+// =================================================================
+// 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 ProfileUser subscriptions = 16;
+    repeated ProfileUser subscribers = 17;
+    bool is_owner = 18;
+    bool is_subscribed = 19; // viewer is subscribed to this profile (false when anonymous / self)
+    // Premium fields — populated only when the profile owner has an active
+    // PremiumSubscription. Non-premium viewers and non-premium profiles see
+    // empty strings / false.
+    bool is_premium = 20;
+    string profile_color = 21;
+    AvatarBorder avatar_border = 22;
+    string animated_avatar_url = 23;
+    string animated_banner_url = 24;
+    string premium_expires_at = 25; // ISO 8601, empty when not premium
+}
+
+// =================================================================
+// 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;
+    // Premium-only fields — rejected with FAILED_PRECONDITION when the caller
+    // has no active premium. Empty string clears the value.
+    string profile_color = 11;
+    string avatar_border_id = 12;
+    string animated_avatar_url = 13;
+    string animated_banner_url = 14;
+}
+
+// =================================================================
+// 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;
+    string action = 4; // "grant" (default) | "revoke"
+}
+
+// =================================================================
+// 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 ProfileUser subscriptions = 3;
+    repeated ProfileUser subscribers = 4;
+    int32 total = 5;
+    int32 page = 6;
+    int32 limit = 7;
+}
+
+// =================================================================
+// Subscriptions
+// =================================================================
+
+message SubscriptionRequest {
+    string subscriber_id = 1; // the authenticated user performing the action
+    string target_id = 2;     // the user being (un)subscribed to/from
+}
+
+message SubscriptionResponse {
+    bool subscribed = 1;          // state after the call
+    int32 subscribers_count = 2;  // target's subscriber count after the call
+}
+
+// =================================================================
+// Premium
+// =================================================================
+
+// Periods mirror PremiumPeriod enum in schema.prisma.
+enum PremiumPeriod {
+    PREMIUM_PERIOD_UNSPECIFIED = 0;
+    PREMIUM_PERIOD_MONTH_1 = 1;
+    PREMIUM_PERIOD_MONTH_3 = 2;
+    PREMIUM_PERIOD_MONTH_6 = 3;
+    PREMIUM_PERIOD_MONTH_12 = 4;
+}
+
+message GetMyPremiumRequest {
+    string user_id = 1;
+}
+
+message PremiumStateResponse {
+    bool is_active = 1;
+    string status = 2;              // ACTIVE | EXPIRED | CANCELED | empty (never purchased)
+    PremiumPeriod current_period = 3;
+    string started_at = 4;          // ISO 8601, empty when never purchased
+    string expires_at = 5;          // ISO 8601
+    bool auto_renew = 6;
+    bool has_saved_payment_method = 7;
+}
+
+message SetPremiumAutoRenewRequest {
+    string user_id = 1;
+    bool enabled = 2;
+}
+
+// Internal — payments-service hands us the period that was just paid for, plus
+// the YooKassa payment_method id (empty for balance/non-recurring purchases).
+message ActivatePremiumRequest {
+    string user_id = 1;
+    PremiumPeriod period = 2;
+    string payment_method_id = 3;   // empty for BALANCE / one-shot
+    bool is_renewal = 4;            // false = first purchase; true = cron-driven renewal
+}
+
+message IsPremiumActiveRequest {
+    string user_id = 1;
+}
+
+message IsPremiumActiveResponse {
+    bool is_active = 1;
+}
+
+// =================================================================
+// Avatar borders
+// =================================================================
+
+message AvatarBorder {
+    string id = 1;
+    string code = 2;
+    string name = 3;
+    string description = 4;
+    string image_url = 5;
+    bool is_animated = 6;
+    string source = 7;
+    int32 sort_order = 8;
+    bool is_active = 9;
+}
+
+message ListAvatarBordersRequest {
+    bool include_inactive = 1; // admin-only — gateway gates by role
+    string source = 2;         // optional filter
+}
+
+message ListAvatarBordersResponse {
+    repeated AvatarBorder items = 1;
+}
+
+message UpsertAvatarBorderRequest {
+    string id = 1;          // empty = create
+    string code = 2;        // required when creating
+    string name = 3;
+    string description = 4;
+    string image_url = 5;
+    bool is_animated = 6;
+    string source = 7;
+    int32 sort_order = 8;
+    bool is_active = 9;
+}
+
+message DeleteAvatarBorderRequest {
+    string id = 1;
+}
+
+message DeleteAvatarBorderResponse {
+    bool ok = 1;
+}