jr-common-micro 1.1.93 → 1.1.95

package/proto/micro/v1/subscription/services.proto

@@ -0,0 +1,28 @@
+syntax = "proto3";
+
+package micro.v1.subscription;
+
+import "micro/v1/general.proto";
+import "micro/v1/subscription/subscription_messages.proto";
+
+// Paid plans. The store side (receipts, renewals, refunds) is handled by
+// RevenueCat; this service turns its view of a customer into our own
+// entitlement rows, which every other service reads. Nothing else talks to
+// the store.
+service PSubscriptionService {
+  // The caller's plan and entitlements as we know them (no store call).
+  rpc Me(EmptyRequest) returns(stream SubscriptionMeResponse) {}
+  // The caller just bought or restored: pull the store's view now instead
+  // of waiting for the webhook. Rate-limited per person.
+  rpc Sync(EmptyRequest) returns(stream SubscriptionMeResponse) {}
+  // Service-to-service: entitlements of many users at once (chat/data).
+  rpc EntitlementsByIds(EntitlementsByIdsRequest) returns(stream EntitlementsListResponse) {}
+  // RevenueCat webhook, forwarded by the gateway with its raw body.
+  rpc Webhook(SubscriptionWebhookRequest) returns(stream EmptyResponse) {}
+  // Support tools.
+  rpc AdminRead(ByIdRequest) returns(stream SubscriptionAdminResponse) {}
+  rpc AdminGrant(SubscriptionGrantRequest) returns(stream SubscriptionAdminResponse) {}
+  rpc AdminRevoke(SubscriptionRevokeRequest) returns(stream SubscriptionAdminResponse) {}
+  // Account deletion parity with every other micro.
+  rpc RemoveUserData(ByIdRequest) returns(stream EmptyResponse) {}
+}

package/proto/micro/v1/subscription/subscription_messages.proto

@@ -0,0 +1,112 @@
+syntax = "proto3";
+
+package micro.v1.subscription;
+
+import "micro/v1/general.proto";
+
+// A person's standing on one plan. `plan` is the RevenueCat entitlement
+// identifier (premium); the feature keys it unlocks live in jr-common
+// utils/entitlements.
+message SubscriptionInfo {
+  string plan = 1;
+  // active | cancelled (renewal off, access until expires_at) | grace
+  // (payment failed, access until grace_until) | paused | expired | refunded
+  string status = 2;
+  string product_id = 3;
+  // app_store | play_store | promotional | stripe ...
+  string store = 4;
+  // production | sandbox
+  string environment = 5;
+  // normal | trial | intro | promotional | prepaid
+  string period_type = 6;
+  // RFC 3339, UTC. Empty when unknown.
+  string purchased_at = 7;
+  string original_purchase_at = 8;
+  string expires_at = 9;
+  string grace_until = 10;
+  // Until when the person keeps the features (expires_at or grace_until).
+  string access_until = 11;
+  bool auto_renew = 12;
+  // purchased | family_shared
+  string ownership_type = 13;
+  // Google pause: when billing resumes.
+  string auto_resume_at = 14;
+  // Store page where the person manages the subscription (may be empty).
+  string management_url = 15;
+}
+
+// One unlocked feature. `key` is a catalogue key such as badge.premium;
+// `expires_at` empty means no end date (manual grants).
+message EntitlementInfo {
+  string key = 1;
+  string expires_at = 2;
+  string plan = 3;
+  // subscription | promotional
+  string source = 4;
+}
+
+message SubscriptionMeResponse {
+  ResponseStatus status = 1;
+  optional SubscriptionInfo subscription = 2;
+  repeated EntitlementInfo entitlements = 3;
+  // When the store was last consulted for this person (RFC 3339).
+  string synced_at = 4;
+}
+
+message EntitlementsByIdsRequest {
+  repeated string user_ids = 1;
+}
+
+message UserEntitlements {
+  string user_id = 1;
+  repeated EntitlementInfo entitlements = 2;
+}
+
+message EntitlementsListResponse {
+  ResponseStatus status = 1;
+  repeated UserEntitlements data = 2;
+}
+
+// The webhook exactly as RevenueCat sent it. The body stays raw so the
+// HMAC signature can be checked over the original bytes.
+message SubscriptionWebhookRequest {
+  string authorization = 1;
+  string signature = 2;
+  string raw_body = 3;
+}
+
+message SubscriptionEventInfo {
+  string id = 1;
+  string type = 2;
+  string store = 3;
+  string product_id = 4;
+  string environment = 5;
+  string received_at = 6;
+  string processed_at = 7;
+  string error = 8;
+}
+
+message SubscriptionAdminResponse {
+  ResponseStatus status = 1;
+  repeated SubscriptionInfo subscriptions = 2;
+  repeated EntitlementInfo entitlements = 3;
+  // Newest first, capped.
+  repeated SubscriptionEventInfo events = 4;
+  string synced_at = 5;
+}
+
+// Support: give a plan for a while without a purchase (goes through the
+// store layer as a promotional entitlement, so it is visible everywhere).
+// duration: daily | three_day | weekly | monthly | two_month | three_month
+// | six_month | yearly | lifetime
+message SubscriptionGrantRequest {
+  string user_id = 1;
+  string plan = 2;
+  string duration = 3;
+  string note = 4;
+}
+
+message SubscriptionRevokeRequest {
+  string user_id = 1;
+  string plan = 2;
+}

package/proto/micro/v1/user/services.proto

@@ -76,6 +76,8 @@ service PProfileService {
   rpc Followers(PaginateRequest) returns(stream ProfileListResponse) {}
   rpc ProfilesByIds(ProfilesByIdsRequest) returns(stream ProfileListResponse) {}
   rpc Following(PaginateRequest) returns(stream ProfileListResponse) {}
+  // Service-to-service only (internal hash, no user token).
+  rpc SetSubscriptionBadge(SubscriptionBadgeRequest) returns(stream UserBadgesResponse) {}
 }
 
 // Admin

package/proto/micro/v1/user/user_messages.proto

@@ -49,6 +49,17 @@ message UserBadgesResponse {
   repeated string badges = 2;
 }
 
+// Internal (subscription service): keep a plan's badge in step with the
+// plan. active=true (re)grants with source=subscription until expires_at
+// (RFC 3339, empty = open-ended); active=false revokes it. Never touches
+// badges granted by hand.
+message SubscriptionBadgeRequest {
+  string user_id = 1;
+  string badge = 2;
+  bool active = 3;
+  string expires_at = 4;
+}
+
 enum TfaSelectionEnum { nothing = 0; sms = 1; authenticator = 2; }
 
 message UserProfileDto {