Skip to main content

acosmi/subscription/
types.rs

1//! 订阅域类型。端口自 `subscription/types.ts`(商品化总规划 P1 订阅档位)。
2//!
3//! 与 tk-dist `DistSubscriptionPlanDO` / 网关 `membershipResponse` / `GetSubscription` 对齐。
4
5use crate::macros::open_string_union;
6use serde::{Deserialize, Serialize};
7use std::collections::HashMap;
8
9open_string_union! {
10    /// 订阅档位受众。TS `SubscriptionAudience`(闭集,但保留前向兼容 → 开放 union)。
11    SubscriptionAudience {
12        PERSONAL => "PERSONAL",
13        ENTERPRISE => "ENTERPRISE",
14    }
15}
16
17open_string_union! {
18    /// 滚存策略。TS `RolloverPolicy`。
19    RolloverPolicy {
20        NONE => "NONE",
21        PARTIAL => "PARTIAL",
22        FULL => "FULL",
23    }
24}
25
26/// 公开订阅计划(字段白名单,不含 feature_gate / seat_rule_json 等内部字段)。TS `SubscriptionPlan`。
27#[derive(Debug, Clone, Serialize, Deserialize)]
28pub struct SubscriptionPlan {
29    pub id: i64,
30    #[serde(rename = "planCode")]
31    pub plan_code: String,
32    pub audience: SubscriptionAudience,
33    #[serde(rename = "tierLevel")]
34    pub tier_level: i64,
35    #[serde(rename = "planName")]
36    pub plan_name: String,
37    #[serde(rename = "planDesc")]
38    pub plan_desc: String,
39    #[serde(rename = "billingCycle")]
40    pub billing_cycle: String,
41    /// 基准价(整数分,§3 finance/商品化阵营)。
42    #[serde(rename = "basePriceFen")]
43    pub base_price_fen: i64,
44    /// 档位标准额度。付费档单位 = 微 Credits(÷1000 = Credits);免费档 = 原始 Token。
45    #[serde(rename = "tokenQuota")]
46    pub token_quota: i64,
47    #[serde(rename = "seatMin", default, skip_serializing_if = "Option::is_none")]
48    pub seat_min: Option<i64>,
49    #[serde(rename = "seatMax", default, skip_serializing_if = "Option::is_none")]
50    pub seat_max: Option<i64>,
51    #[serde(
52        rename = "rolloverPolicy",
53        default,
54        skip_serializing_if = "Option::is_none"
55    )]
56    pub rollover_policy: Option<RolloverPolicy>,
57    #[serde(
58        rename = "basePlanCode",
59        default,
60        skip_serializing_if = "Option::is_none"
61    )]
62    pub base_plan_code: Option<String>,
63    /// 与 base_plan_code 一组使用;十进制系数透传字符串(§3 json.Number 阵营)。
64    #[serde(
65        rename = "tkMultiplier",
66        default,
67        skip_serializing_if = "Option::is_none"
68    )]
69    pub tk_multiplier: Option<String>,
70    #[serde(
71        rename = "priceMultiplier",
72        default,
73        skip_serializing_if = "Option::is_none"
74    )]
75    pub price_multiplier: Option<String>,
76    /// grant_policy 摘要(P3 商品中心补;动态 JSON)。
77    #[serde(
78        rename = "grantPolicyDigest",
79        default,
80        skip_serializing_if = "Option::is_none"
81    )]
82    pub grant_policy_digest: Option<HashMap<String, serde_json::Value>>,
83}
84
85/// C 端会员中心订阅概览。严格对齐网关 GET /entitlements/membership。TS `Membership`。
86#[derive(Debug, Clone, Serialize, Deserialize)]
87pub struct Membership {
88    #[serde(rename = "hasActive")]
89    pub has_active: bool,
90    #[serde(rename = "planCode")]
91    pub plan_code: String,
92    #[serde(rename = "planName")]
93    pub plan_name: String,
94    pub tier: String,
95    #[serde(rename = "billingCycle")]
96    pub billing_cycle: String,
97    pub status: String,
98    #[serde(rename = "expiresAt")]
99    pub expires_at: String,
100    /// 价格(整数分,§3)。
101    #[serde(rename = "priceFen")]
102    pub price_fen: i64,
103    /// 周期总额度。有活跃付费订阅时单位 = 微 Credits;免费档 = 原始 Token。
104    #[serde(rename = "tokenQuota")]
105    pub token_quota: i64,
106    /// 当前周期已用(后端 float64)。单位同 token_quota:付费=微 Credits / 免费=Token。
107    #[serde(rename = "tokenUsed")]
108    pub token_used: f64,
109    #[serde(rename = "periodStart")]
110    pub period_start: String,
111    /// is_free = !has_active(无活跃付费订阅即免费档)。
112    #[serde(rename = "isFree")]
113    pub is_free: bool,
114}
115
116/// 由活跃权益推导的订阅层级。对齐网关 GET /entitlements/subscription。TS `SubscriptionTier`。
117#[derive(Debug, Clone, Serialize, Deserialize)]
118pub struct SubscriptionTier {
119    /// "free" | "pro"(后端按权益类型推导)。
120    #[serde(rename = "subscriptionType")]
121    pub subscription_type: String,
122    #[serde(rename = "activeEntitlementTypes")]
123    pub active_entitlement_types: Vec<String>,
124}
125
126/// 订阅支付前绑定硬闸返回体(`{ok:bool}`)。
127#[derive(Debug, Clone, Serialize, Deserialize)]
128pub struct SubscriptionPrecheckResult {
129    pub ok: bool,
130}
131
132/// **@deprecated** 网关未暴露订阅列表端点;该形状不对应任何真实响应。
133/// 请改用 [`Membership`] + `get_membership()`。保留仅为向后兼容。TS `UserSubscription`。
134#[derive(Debug, Clone, Serialize, Deserialize)]
135pub struct UserSubscription {
136    pub id: i64,
137    #[serde(rename = "userId")]
138    pub user_id: String,
139    #[serde(rename = "planId")]
140    pub plan_id: i64,
141    #[serde(rename = "planCode", default, skip_serializing_if = "Option::is_none")]
142    pub plan_code: Option<String>,
143    #[serde(default, skip_serializing_if = "Option::is_none")]
144    pub audience: Option<SubscriptionAudience>,
145    /// active / paused / cancelled。
146    pub status: String,
147    /// ISO date — yyyy-MM-dd 字符串(Java LocalDate.toString)。
148    #[serde(
149        rename = "nextDeductDate",
150        default,
151        skip_serializing_if = "Option::is_none"
152    )]
153    pub next_deduct_date: Option<String>,
154    #[serde(
155        rename = "agreementNo",
156        default,
157        skip_serializing_if = "Option::is_none"
158    )]
159    pub agreement_no: Option<String>,
160}
161
162#[cfg(test)]
163mod tests {
164    use super::*;
165
166    #[test]
167    fn subscription_plan_base_price_fen_i64_token_used_f64() {
168        let p: SubscriptionPlan = serde_json::from_str(
169            r#"{"id":1,"planCode":"PRO","audience":"PERSONAL","tierLevel":2,"planName":"Pro",
170                "planDesc":"d","billingCycle":"MONTHLY","basePriceFen":39900,"tokenQuota":300000000,
171                "tkMultiplier":"5","priceMultiplier":"3.3"}"#,
172        )
173        .unwrap();
174        // basePriceFen = i64 整数分(§3)。
175        assert_eq!(p.base_price_fen, 39900_i64);
176        // tokenQuota = i64(额度,>2^28)。
177        assert_eq!(p.token_quota, 300_000_000_i64);
178        // 十进制系数透传字符串(§3 json.Number 阵营)。
179        assert_eq!(p.tk_multiplier.as_deref(), Some("5"));
180        assert_eq!(p.price_multiplier.as_deref(), Some("3.3"));
181        assert_eq!(p.audience.as_str(), "PERSONAL");
182    }
183
184    #[test]
185    fn membership_token_used_is_f64() {
186        let m: Membership = serde_json::from_str(
187            r#"{"hasActive":true,"planCode":"PRO","planName":"Pro","tier":"pro",
188                "billingCycle":"MONTHLY","status":"ACTIVE","expiresAt":"2026-12-31",
189                "priceFen":39900,"tokenQuota":300000000,"tokenUsed":12345.5,
190                "periodStart":"2026-06-01","isFree":false}"#,
191        )
192        .unwrap();
193        // priceFen = i64;tokenUsed = f64(后端 float64)。
194        assert_eq!(m.price_fen, 39900_i64);
195        assert_eq!(m.token_used, 12345.5_f64);
196        assert!(m.has_active);
197    }
198}