cmd_usage/ocuse/
zen.rs

1// The docs catalogue: what a model costs and what each *plan* allows.
2//
3// Generated by `scripts/extract-zen.ts` (run `bun scripts/extract-zen.ts`) from
4// OpenCode's own docs sources, so the numbers move with upstream instead of
5// living in code. Go ships two plans (Go $10/mo, Go Plus $40/mo) that share one
6// token price list but grant each model a different monthly dollar limit; Zen is
7// pay-as-you-go, so it has rates but no limits.
8//
9// Which plan you are on is not discoverable: the usage endpoint reports the
10// meters' percentages, not a plan id, and the local store records no
11// subscription, so `ocuse` takes a `--plan` flag and defaults to
12// [`DEFAULT_PLAN`].
13use serde::Deserialize;
14use std::collections::BTreeMap;
15
16// Re-exported from `cmduse-core` so the path stays inside its own crate (a
17// `include_str!` reaching outside is fine locally and fatal at `cargo publish`).
18const RAW: &str = cmduse_core::ZEN_JSON;
19
20/// The plan `ocuse` measures against when `--plan` is not given.
21pub const DEFAULT_PLAN: &str = "go";
22
23#[derive(Debug, Clone, Deserialize)]
24pub struct RateVariant {
25    pub peak: Option<String>,
26    #[serde(rename = "tierMaxTokens")]
27    pub tier_max_tokens: Option<u64>,
28    #[serde(rename = "tierMinTokens")]
29    pub tier_min_tokens: Option<u64>,
30    pub input: f64,
31    pub output: f64,
32    #[serde(rename = "cacheRead")]
33    pub cache_read: f64,
34    #[serde(rename = "cacheWrite")]
35    pub cache_write: f64,
36}
37
38#[derive(Debug, Clone, Deserialize)]
39pub struct Model {
40    pub id: String,
41    pub name: String,
42    pub variants: Vec<RateVariant>,
43}
44
45#[derive(Debug, Clone, Deserialize)]
46pub struct WindowShare {
47    #[serde(rename = "fiveHour")]
48    pub five_hour: f64,
49    pub weekly: f64,
50    pub monthly: f64,
51}
52
53/// One Go plan: a price plus a monthly dollar limit per model id.
54#[derive(Debug, Clone, Deserialize)]
55pub struct GoPlan {
56    pub label: String,
57    #[serde(rename = "priceUsd")]
58    pub price_usd: f64,
59    /// model id -> monthly dollar limit; a missing id is free/unlimited.
60    #[serde(rename = "allowanceByModel")]
61    pub allowance_by_model: BTreeMap<String, f64>,
62}
63
64#[derive(Debug, Clone, Deserialize)]
65pub struct Go {
66    #[serde(rename = "windowShare")]
67    pub window_share: WindowShare,
68    /// Token rates, shared across plans (pricing is the same for both).
69    pub models: Vec<Model>,
70    /// Keyed by plan slug ("go", "go-plus"); only the allowances differ.
71    pub plans: BTreeMap<String, GoPlan>,
72}
73
74#[derive(Debug, Clone, Deserialize)]
75pub struct Zen {
76    pub models: Vec<Model>,
77}
78
79#[derive(Debug, Clone, Deserialize)]
80pub struct Catalog {
81    #[serde(rename = "extractedAt")]
82    pub extracted_at: String,
83    pub go: Go,
84    pub zen: Zen,
85}
86
87/// Parsed once; the file is a compile-time constant.
88pub fn catalog() -> Catalog {
89    serde_json::from_str(RAW)
90        .expect("core/zen.json is generated; regenerate with scripts/extract-zen.ts")
91}
92
93impl Catalog {
94    /// The plan ids the docs define, in the map's (alphabetical) order — "go"
95    /// sorts before "go-plus", which is the order they read in the docs.
96    pub fn plan_ids(&self) -> Vec<&str> {
97        self.go.plans.keys().map(String::as_str).collect()
98    }
99
100    pub fn plan(&self, plan_id: &str) -> Option<&GoPlan> {
101        self.go.plans.get(plan_id)
102    }
103
104    /// Monthly dollar limit for a model under one plan, if the docs list one.
105    /// None for a free/unlimited model, an unknown model, or an unknown plan.
106    pub fn go_limit(&self, plan_id: &str, model_id: &str) -> Option<f64> {
107        self.plan(plan_id)
108            .and_then(|plan| plan.allowance_by_model.get(model_id).copied())
109    }
110}
111
112/// Suggested cap for a rolling window, from the documented share of the limit.
113pub fn window_cap(limit: f64, share: f64) -> f64 {
114    limit * share
115}
116
117#[cfg(test)]
118mod tests {
119    use super::*;
120
121    #[test]
122    fn catalogue_parses_and_carries_both_plans() {
123        let c = catalog();
124        assert!(c.go.models.len() > 20, "go models: {}", c.go.models.len());
125        assert!(!c.zen.models.is_empty());
126        assert_eq!(c.plan_ids(), vec!["go", "go-plus"]);
127        assert_eq!(c.plan("go").map(|p| p.price_usd), Some(10.0));
128        assert_eq!(c.plan("go-plus").map(|p| p.price_usd), Some(40.0));
129        assert_eq!(c.go_limit("go", "glm-5.3-flash"), Some(60.0));
130        assert_eq!(c.go_limit("go-plus", "glm-5.3-flash"), Some(180.0));
131        assert_eq!(c.go_limit("go", "nope-not-a-model"), None);
132        assert_eq!(c.go_limit("nope-not-a-plan", "glm-5.3-flash"), None);
133    }
134
135    #[test]
136    fn plans_share_the_model_set_and_differ_on_allowance() {
137        let c = catalog();
138        let go = c.plan("go").expect("go");
139        let plus = c.plan("go-plus").expect("go-plus");
140        assert_eq!(go.label, "Go");
141        assert_eq!(plus.label, "Go Plus");
142        assert_eq!(go.allowance_by_model.len(), plus.allowance_by_model.len());
143        // Rates are shared, so every allowance model is in the other plan too,
144        // and Go Plus grants more on at least one of them.
145        assert!(plus
146            .allowance_by_model
147            .iter()
148            .all(|(id, _)| go.allowance_by_model.contains_key(id)));
149        assert!(plus
150            .allowance_by_model
151            .iter()
152            .any(|(id, limit)| go.allowance_by_model.get(id).is_some_and(|g| limit > g)));
153    }
154
155    #[test]
156    fn window_split_matches_the_docs() {
157        let c = catalog();
158        assert_eq!(c.go.window_share.five_hour, 0.2);
159        assert_eq!(c.go.window_share.weekly, 0.5);
160        assert_eq!(c.go.window_share.monthly, 1.0);
161        assert_eq!(window_cap(60.0, c.go.window_share.five_hour), 12.0);
162    }
163
164    #[test]
165    fn tiered_and_peak_variants_are_kept() {
166        let c = catalog();
167        let qwen =
168            c.go.models
169                .iter()
170                .find(|m| m.id == "qwen3.7-plus")
171                .expect("qwen3.7-plus");
172        assert_eq!(qwen.variants.len(), 2);
173        assert!(qwen
174            .variants
175            .iter()
176            .any(|v| v.tier_max_tokens == Some(256_000)));
177        let deepseek =
178            c.go.models
179                .iter()
180                .find(|m| m.id == "deepseek-v4-flash")
181                .expect("deepseek");
182        assert!(deepseek
183            .variants
184            .iter()
185            .any(|v| v.peak.as_deref() == Some("peak")));
186    }
187}
cmd_usage/ocuse/zen.rs

cmd_usage/ocuse/
zen.rs
