jr-common-micro 1.1.95 → 1.1.97

package/proto/micro/v1/mining/mining_messages.proto

@@ -0,0 +1,366 @@
+syntax = "proto3";
+
+package micro.v1.mining;
+
+import "micro/v1/general.proto";
+
+// JR: a free, simulated in-app point ("kazı"). Amounts travel as decimal
+// strings with 6 fraction digits ("186.797810"); hourly rates as decimal
+// strings too. Times are RFC 3339 UTC. Nothing here is money: JR cannot
+// be bought, sold or transferred.
+
+// The open (or last) 24-hour session.
+message SessionInfo {
+  string id = 1;
+  string started_at = 2;
+  string ends_at = 3;
+  // Set once the session is over (by the sweep or on read).
+  string closed_at = 4;
+  // JR earned so far (settled up to `settled_at`); the app ticks on from
+  // there with `hourly`.
+  string earned = 5;
+  string settled_at = 6;
+  // Expected total if the current rate held for the whole session.
+  string projected = 7;
+  bool open = 8;
+}
+
+// How the hourly rate comes together: hourly = base × multiplier,
+// multiplier = min(cap, badge + own_tasks + team_share + full_team).
+message RateInfo {
+  string base = 1;
+  // standard | blue | yellow
+  string badge = 2;
+  string badge_base = 3;
+  string own_tasks = 4;
+  string team_share = 5;
+  string full_team = 6;
+  // Team members that reached the full-team task threshold today.
+  int32 full_team_ready = 7;
+  int32 full_team_size = 8;
+  string multiplier = 9;
+  string cap = 10;
+  string hourly = 11;
+}
+
+// Base-rate halving progress.
+message HalvingInfo {
+  int32 users = 1;
+  int32 next_threshold = 2;
+  string next_base = 3;
+  int32 halvings = 4;
+}
+
+// Referral earnings: two levels, accrued into a pool, moved to the balance
+// with Claim.
+message ReferralInfo {
+  string code = 1;
+  string link = 2;
+  string pending = 3;
+  // Estimated pool growth per hour (display only; the pool itself is
+  // credited from the referrals' settled mining).
+  string pending_hourly = 4;
+  string l1_share = 5;
+  string l2_share = 6;
+  int32 l1_count = 7;
+  int32 l1_mining = 8;
+  int32 l2_count = 9;
+  int32 l2_mining = 10;
+  // Lifetime totals already claimed, by source.
+  string earned_l1 = 11;
+  string earned_l2 = 12;
+  string earned_gifts = 13;
+  string earned_total = 14;
+  // Who invited this person (empty when nobody).
+  string referred_by_username = 15;
+}
+
+message TeamMember {
+  string user_id = 1;
+  string username = 2;
+  string avatar_url = 3;
+  // Tasks done today and the multiplier they add to the owner.
+  int32 tasks_today = 4;
+  string task_multiplier = 5;
+  string contribution = 6;
+  bool mining = 7;
+  bool full_team_ready = 8;
+  // When the member becomes / stops being effective (team lock).
+  string active_from = 9;
+  string active_until = 10;
+  // Nudge state: when the owner may nudge this member again ('' = now).
+  string nudge_available_at = 11;
+}
+
+message TeamInfo {
+  repeated TeamMember members = 1;
+  int32 size = 2;
+  // The team is locked while a session runs; changes apply at this time.
+  bool locked = 3;
+  string locked_until = 4;
+  string share = 5;
+  string full_team_bonus = 6;
+  int32 full_team_min_tasks = 7;
+}
+
+message TaskInfo {
+  string id = 1;
+  // daily | weekly | once
+  string kind = 2;
+  string title = 3;
+  string multiplier = 4;
+  // Times the task may count per period (ads: 5); 1 for most.
+  int32 max_count = 5;
+  int32 done_count = 6;
+  bool done = 7;
+  // When the current completion stops counting ('' when not done).
+  string expires_at = 8;
+  // Client event that completes it (mining_start, x_visit, news_read, ...)
+  // or '' when the server completes it on its own.
+  string event = 9;
+  // Only standard-badge users see it (ads).
+  bool standard_only = 10;
+}
+
+message TasksSummary {
+  int32 done = 1;
+  int32 total = 2;
+  // The next undone task worth the most ('' when all done).
+  string next_id = 3;
+  string next_title = 4;
+  string next_multiplier = 5;
+  // Multiplier if every task of the week were done.
+  string potential_multiplier = 6;
+}
+
+message MiningSettings {
+  bool notify_session_end = 1;
+}
+
+// Everything the Sosyal card and the JR Kazı page need in one answer.
+message MiningState {
+  string user_id = 1;
+  // Settled balance; the app adds the open session's live earnings.
+  string balance = 2;
+  string total_mined = 3;
+  string total_claimed = 4;
+  optional SessionInfo session = 5;
+  RateInfo rate = 6;
+  HalvingInfo halving = 7;
+  ReferralInfo referral = 8;
+  TeamInfo team = 9;
+  TasksSummary tasks = 10;
+  MiningSettings settings = 11;
+  string server_time = 12;
+  // First visit after activation: show the welcome sheet once.
+  bool welcome_pending = 13;
+  // A session ended since the person last opened the app: show its summary.
+  optional SessionInfo ended_session = 14;
+  int32 sessions_completed = 15;
+  int32 streak_days = 16;
+  // Email not verified yet: nothing runs until it is.
+  bool inactive = 17;
+}
+
+message MiningMeResponse {
+  ResponseStatus status = 1;
+  optional MiningState data = 2;
+}
+
+message TasksResponse {
+  ResponseStatus status = 1;
+  repeated TaskInfo daily = 2;
+  repeated TaskInfo weekly = 3;
+  repeated TaskInfo once = 4;
+  optional TasksSummary summary = 5;
+  optional RateInfo rate = 6;
+}
+
+// The app reports what the person did; the server decides which task (if
+// any) it completes.
+message TaskEventRequest {
+  string event = 1;
+  // Free-form payload (prediction choice, article id ...).
+  string payload = 2;
+}
+
+message TaskEventResponse {
+  ResponseStatus status = 1;
+  // Task completed by this event ('' when nothing changed).
+  string completed_task_id = 2;
+  optional MiningState data = 3;
+}
+
+message ReferralItem {
+  string user_id = 1;
+  string username = 2;
+  string avatar_url = 3;
+  int32 level = 4;
+  bool verified = 5;
+  bool mining = 6;
+  int32 sessions_completed = 7;
+  // Referrer's gift: pending | paid | not_eligible
+  string gift_status = 8;
+  int32 referral_count = 9;
+  string hourly_contribution = 10;
+  bool in_team = 11;
+  bool team_eligible = 12;
+  string joined_at = 13;
+}
+
+message ReferralListRequest {
+  int32 page = 1;
+  int32 per_page = 2;
+  // all | mining | team | eligible
+  string filter = 3;
+  string search = 4;
+  int32 level = 5;
+}
+
+message ReferralListResponse {
+  ResponseStatus status = 1;
+  repeated ReferralItem data = 2;
+  optional PaginationMetaResult pagination = 3;
+}
+
+message ClaimResponse {
+  ResponseStatus status = 1;
+  string claimed = 2;
+  optional MiningState data = 3;
+}
+
+message SetTeamRequest {
+  repeated string user_ids = 1;
+}
+
+message TeamResponse {
+  ResponseStatus status = 1;
+  optional TeamInfo data = 2;
+  optional RateInfo rate = 3;
+}
+
+message HistoryRequest {
+  int32 page = 1;
+  int32 per_page = 2;
+  // all | mining | claim | gift
+  string filter = 3;
+}
+
+message HistoryItem {
+  string id = 1;
+  // mining | referral_claim | invite_gift
+  string kind = 2;
+  string amount = 3;
+  string created_at = 4;
+  // mining: average multiplier; claim: l1/l2/gift breakdown.
+  string detail = 5;
+}
+
+message HistoryDay {
+  string date = 1;
+  string amount = 2;
+}
+
+message HistoryResponse {
+  ResponseStatus status = 1;
+  repeated HistoryItem data = 2;
+  optional PaginationMetaResult pagination = 3;
+  // Last 7 days, for the chart.
+  repeated HistoryDay week = 4;
+}
+
+message UpdateSettingsRequest {
+  MiningSettings settings = 1;
+}
+
+// Internal (gateway at registration, or the app once, before activation):
+// attach the invite code and device fingerprint to a new account.
+message EnrollRequest {
+  string user_id = 1;
+  string referral_code = 2;
+  string device_hash = 3;
+}
+
+message EnrollResponse {
+  ResponseStatus status = 1;
+  bool referral_attached = 2;
+  // invalid_code | self | already_referred | too_late | same_device | ''
+  string reason = 3;
+}
+
+// Public: who an invite code belongs to, for the web invite page.
+message ResolveCodeRequest {
+  string code = 1;
+}
+
+message ResolveCodeResponse {
+  ResponseStatus status = 1;
+  bool valid = 2;
+  string username = 3;
+  string avatar_url = 4;
+  string gift = 5;
+}
+
+message AdminOverviewRequest {
+  // today | week | month
+  string period = 1;
+}
+
+message AdminMetric {
+  string key = 1;
+  string value = 2;
+  // Change against the previous period, as a signed percentage string.
+  string change = 3;
+}
+
+message AdminSeriesPoint {
+  string date = 1;
+  string value = 2;
+}
+
+message AdminSeries {
+  string key = 1;
+  repeated AdminSeriesPoint points = 2;
+}
+
+message AdminTaskStat {
+  string task_id = 1;
+  string title = 2;
+  string completion_rate = 3;
+  string change = 4;
+}
+
+message AdminTopReferrer {
+  string user_id = 1;
+  string username = 2;
+  int32 referrals = 3;
+  string active_rate = 4;
+  string earned = 5;
+}
+
+message AdminOverviewResponse {
+  ResponseStatus status = 1;
+  repeated AdminMetric metrics = 2;
+  repeated AdminSeries series = 3;
+  repeated AdminTaskStat tasks = 4;
+  repeated AdminTopReferrer top_referrers = 5;
+  int32 suspicious_accounts = 6;
+}
+
+message ParameterItem {
+  string key = 1;
+  // JSON value.
+  string value = 2;
+  string updated_at = 3;
+  string updated_by = 4;
+}
+
+message ParametersResponse {
+  ResponseStatus status = 1;
+  repeated ParameterItem data = 2;
+}
+
+message SetParameterRequest {
+  string key = 1;
+  string value = 2;
+}

package/proto/micro/v1/mining/services.proto

@@ -0,0 +1,45 @@
+syntax = "proto3";
+
+package micro.v1.mining;
+
+import "micro/v1/general.proto";
+import "micro/v1/mining/mining_messages.proto";
+
+// JR: the free, simulated in-app point behind the Sosyal tab. Sessions,
+// rates, tasks, referrals, teams and the ledger all live here; the gateway
+// forwards the caller's token, the app only shows what this service says.
+service PMiningService {
+  // The caller's whole state (card + JR Kazı page). Initializes the person
+  // on first call once their email is verified.
+  rpc Me(EmptyRequest) returns(stream MiningMeResponse) {}
+  // Start the next 24-hour session (the first one starts on its own).
+  rpc StartSession(EmptyRequest) returns(stream MiningMeResponse) {}
+  // The welcome sheet / ended-session summary was shown.
+  rpc Acknowledge(ByIdRequest) returns(stream EmptyResponse) {}
+
+  rpc Tasks(EmptyRequest) returns(stream TasksResponse) {}
+  rpc TaskEvent(TaskEventRequest) returns(stream TaskEventResponse) {}
+
+  rpc Referrals(ReferralListRequest) returns(stream ReferralListResponse) {}
+  rpc Claim(EmptyRequest) returns(stream ClaimResponse) {}
+
+  rpc Team(EmptyRequest) returns(stream TeamResponse) {}
+  rpc SetTeam(SetTeamRequest) returns(stream TeamResponse) {}
+  rpc Nudge(ByIdRequest) returns(stream EmptyResponse) {}
+
+  rpc History(HistoryRequest) returns(stream HistoryResponse) {}
+  rpc UpdateSettings(UpdateSettingsRequest) returns(stream MiningMeResponse) {}
+
+  // Internal (gateway after registration) or the app before activation.
+  rpc Enroll(EnrollRequest) returns(stream EnrollResponse) {}
+  // Public, for the web invite page.
+  rpc ResolveCode(ResolveCodeRequest) returns(stream ResolveCodeResponse) {}
+
+  // Admin.
+  rpc AdminOverview(AdminOverviewRequest) returns(stream AdminOverviewResponse) {}
+  rpc AdminParameters(EmptyRequest) returns(stream ParametersResponse) {}
+  rpc AdminSetParameter(SetParameterRequest) returns(stream ParametersResponse) {}
+
+  // Account deletion parity with every other micro.
+  rpc RemoveUserData(ByIdRequest) returns(stream EmptyResponse) {}
+}

package/proto/micro/v1/notification/notification_messages.proto

@@ -133,6 +133,25 @@ message SendNotificationRequest {
   NotificationMessage notificationMessage = 3;
 }
 
+// Generic targeted push: one text per language, the same data for every
+// device. `lane` urgent|bulk picks the queue; `collapse_id` replaces an
+// earlier push with the same id (max 64 bytes); `ttl_seconds` drops it when
+// it is no longer worth delivering.
+message SendUserPushRequest {
+  repeated string user_ids = 1;
+  string title_tr = 2;
+  string title_en = 3;
+  string body_tr = 4;
+  string body_en = 5;
+  // key=value pairs the app routes with (e.g. screen=mining).
+  map<string, string> data = 6;
+  string lane = 7;
+  string collapse_id = 8;
+  int32 ttl_seconds = 9;
+  // default | normal | high
+  string priority = 10;
+}
+
 // Targeted push for chat mentions (localized body built micro-side).
 message SendChatMentionRequest {
   repeated string user_ids = 1;

package/proto/micro/v1/notification/services.proto

@@ -19,6 +19,9 @@ service PNotificationService {
   rpc SendTestNotification(SendTestNotificationRequest) returns(stream EmptyResponse) {}
   rpc SendNotification(SendNotificationRequest) returns(stream EmptyResponse) {}
   rpc SendChatMention(SendChatMentionRequest) returns(stream EmptyResponse) {}
+  // Generic targeted push for other services (JR session end ...): the
+  // caller gives the text per language and the data the tap routes with.
+  rpc SendUserPush(SendUserPushRequest) returns(stream EmptyResponse) {}
   rpc GetUserNotificationPreferences(GetUserNotificationPreferencesRequest) returns(stream GetUserNotificationPreferencesResponse) {}
   rpc SaveMobileNotification(SaveMobileNotificationRequest) returns(stream EmptyResponse) {}
   rpc GetUserMobileNotification(GetUserMobileNotificationRequest) returns(stream GetUserMobileNotificationPaginationResponse) {}

package/proto/micro/v1/support/services.proto

@@ -0,0 +1,24 @@
+syntax = "proto3";
+
+package micro.v1.support;
+
+import "micro/v1/general.proto";
+import "micro/v1/support/support_messages.proto";
+
+// Support tickets. Person-side calls carry the app token; the admin calls
+// require the admin role; RemoveUserData is internal (account deletion).
+service PSupportService {
+  rpc CreateTicket(CreateTicketRequest) returns(stream TicketThreadResponse) {}
+  rpc MyTickets(TicketListRequest) returns(stream TicketListResponse) {}
+  // The thread; marks the admin's answers as read for the person.
+  rpc Ticket(ByIdRequest) returns(stream TicketThreadResponse) {}
+  // A person writing into their own ticket, or an admin answering any.
+  rpc Reply(ReplyRequest) returns(stream TicketThreadResponse) {}
+
+  rpc AdminTickets(TicketListRequest) returns(stream TicketListResponse) {}
+  // The thread for an admin; marks the person's messages as read for admins.
+  rpc AdminTicket(ByIdRequest) returns(stream TicketThreadResponse) {}
+  rpc AdminSetStatus(SetStatusRequest) returns(stream TicketThreadResponse) {}
+
+  rpc RemoveUserData(ByIdRequest) returns(stream EmptyResponse) {}
+}

package/proto/micro/v1/support/support_messages.proto

@@ -0,0 +1,96 @@
+syntax = "proto3";
+
+package micro.v1.support;
+
+import "micro/v1/general.proto";
+
+// In-app support tickets ("Destek"): a person writes from the app, admins
+// answer from the admin panel or the app. Lives in jr-mining-micro next to
+// JR, served under its own package. Times are RFC 3339 UTC.
+
+// A ticket as lists and the thread header show it.
+message Ticket {
+  string id = 1;
+  // Short human number shown to the person ("#1043").
+  int32 number = 2;
+  string user_id = 3;
+  string username = 4;
+  string avatar_url = 5;
+  // mining | referral | tasks | team | account | other
+  string topic = 6;
+  // open | answered | closed
+  string status = 7;
+  // First message, trimmed, for list rows.
+  string preview = 8;
+  // The newest message, trimmed, for list rows.
+  string last_message = 9;
+  bool last_from_admin = 10;
+  int32 message_count = 11;
+  // Admin replied after the person last looked / person wrote after an admin last looked.
+  bool unread_for_user = 12;
+  bool unread_for_admin = 13;
+  string platform = 14;
+  string app_version = 15;
+  string created_at = 16;
+  string updated_at = 17;
+  string closed_at = 18;
+}
+
+message TicketMessage {
+  string id = 1;
+  string ticket_id = 2;
+  string author_id = 3;
+  string author_username = 4;
+  bool from_admin = 5;
+  string message = 6;
+  string attachment_url = 7;
+  string created_at = 8;
+}
+
+message CreateTicketRequest {
+  string topic = 1;
+  string message = 2;
+  string attachment_url = 3;
+  string platform = 4;
+  string app_version = 5;
+}
+
+message TicketListRequest {
+  int32 page = 1;
+  int32 per_page = 2;
+  // all | open | answered | closed
+  string status = 3;
+  // Admin lists only: username / number / text search.
+  string search = 4;
+}
+
+message ReplyRequest {
+  string ticket_id = 1;
+  string message = 2;
+  string attachment_url = 3;
+}
+
+message SetStatusRequest {
+  string ticket_id = 1;
+  // open | closed
+  string status = 2;
+}
+
+message TicketResponse {
+  ResponseStatus status = 1;
+  optional Ticket data = 2;
+}
+
+message TicketListResponse {
+  ResponseStatus status = 1;
+  repeated Ticket data = 2;
+  optional PaginationMetaResult pagination = 3;
+  // Admin: tickets waiting for an answer; person: tickets with a new answer.
+  int32 attention_count = 4;
+}
+
+message TicketThreadResponse {
+  ResponseStatus status = 1;
+  optional Ticket data = 2;
+  repeated TicketMessage messages = 3;
+}