StepFun provider

StepFun (阶跃星辰) is a web-based provider. Usage data comes from the Step Plan rate limit API, authenticated via an Oasis-Token obtained through a username + password login flow.

Data sources

1. Authentication — Three methods (in priority order):

   • Auto mode: Username + password entered in Settings → Providers → StepFun. CodexBar performs a 3-step login flow to obtain an Oasis-Token:
     1. GET https://platform.stepfun.com → INGRESSCOOKIE
     2. POST …/RegisterDevice → anonymous token
     3. POST …/SignInByPassword → authenticated Oasis-Token The token is cached in Keychain-backed CookieHeaderCache and reused until it expires.
   • Manual mode: Paste an Oasis-Token directly in Settings → Providers → StepFun.
   • Environment variables: STEPFUN_USERNAME + STEPFUN_PASSWORD, or STEPFUN_TOKEN.

2. Rate limit endpoint

   • POST https://platform.stepfun.com/api/step.openapi.devcenter.Dashboard/QueryStepPlanRateLimit
   • Request headers: Cookie: Oasis-Token=<token>, Content-Type: application/json
   • Response fields:
     • five_hour_usage_left_rate — remaining fraction for the 5-hour window (e.g. 0.99781543)
     • weekly_usage_left_rate — remaining fraction for the weekly window
     • five_hour_usage_reset_time — reset timestamp (string or integer)
     • weekly_usage_reset_time — reset timestamp (string or integer)

3. Plan status endpoint

   • POST https://platform.stepfun.com/api/step.openapi.devcenter.Dashboard/GetStepPlanStatus
   • Same auth headers as above
   • Response → subscription.name → plan name (e.g. "Plus", "Mini")
   • If this request fails, usage data is still displayed without a plan name.

Usage details

• Primary window (top bar): 5-hour rate limit (300 minutes).
• Secondary window (bottom bar): weekly rate limit (10 080 minutes).
• usedPercent is computed as (1.0 - left_rate) × 100.
• Plan name is shown as the loginMethod label in the menu card (e.g. "Plus").
• When auth source is set to Off, no background refreshes occur.
• Token expiry triggers automatic re-login (cache is cleared and the 3-step flow runs again).

Key files

• Sources/CodexBarCore/Providers/StepFun/StepFunProviderDescriptor.swift (descriptor + web fetch strategy)
• Sources/CodexBarCore/Providers/StepFun/StepFunUsageFetcher.swift (login flow + HTTP client + JSON parser)
• Sources/CodexBarCore/Providers/StepFun/StepFunSettingsReader.swift (env var resolution)
• Sources/CodexBar/Providers/StepFun/StepFunProviderImplementation.swift (settings fields + activation logic)
• Sources/CodexBar/Providers/StepFun/StepFunSettingsStore.swift (SettingsStore extension)
• Tests/CodexBarTests/StepFunUsageFetcherTests.swift (22 test cases)