Files
codex-helper/docs/frontend/application.md
T

3.1 KiB
Raw Blame History

前端应用

前端位于 frontend/,使用 React 19、TypeScript、Vite、React Router、Lucide 和 Recharts。应用壳和页面位于 frontend/src/main.tsx,API 错误与请求生命周期集中在 api.ts,传输类型和运行时 decoder 位于 types.ts,认证与主题分别由 context 管理。Recharts 图表通过动态 import 独立打包。

状态与路由

应用启动先请求 system/status,已初始化时再请求 auth/me。未初始化渲染安装页;未登录渲染登录页;登录后由 BrowserRouter 提供 / 总览和 /settings 设置,未知路径回到 /。状态响应中的构建版本以 v<version> 徽标显示在安装页、登录页和登录后侧栏的品牌区域。这些分支只负责交互,服务端 session 才是安全边界。

主题以服务端通用设置为持久来源,localStorage 仅用于首屏缓存;system 模式会跟随系统主题变化。当前账号 ID 保存到 localStorage。总览先加载账号列表,为当前账号加载 Dashboard,并在每轮请求完成 30 秒后刷新;切换账号会取消旧请求并校验响应账号,避免迟到响应覆盖当前账号。手动刷新调用账号级 sync 后重新读取 Dashboard。

API 客户端

所有请求使用相对 /api/v1/、credentials: same-origin 和 X-Requested-With: codex-helper,仅 JSON body 设置 content type。请求支持取消和 timeout;非 2xx 响应转换为保留 status 的 ApiError,401 会统一回到登录界面。JSON 响应先作为 unknown,经端点 decoder 校验后进入组件。新增下载或非 JSON 响应不能直接套用当前 api helper。

API 类型精确区分后端 null 与 optional,并为秘密设置拆分读写形状;空数组及 unknown 套餐按后端返回值处理。邮箱在 Web 界面的账号选择器、总览和设置中统一经过 maskEmail;不得把未掩码邮箱添加到新的 Web 可见位置。Telegram /account 是独立的已绑定会话输出,当前显示完整邮箱。

总览与设置

总览显示账户连接、套餐、每个限额窗口的剩余百分比和重置时间、四项摘要及每日 Token 图。usedPercent 展示前限制到 0–100,但原始数据语义不得在 API 类型层改写。缺失摘要显示“暂无”,缺失限额显示明确空状态。

设置页四个 tab 全部保持挂载,以保留未提交表单状态;非活动 panel 使用 aria-hidden 和 inert 隔离。tab 支持方向键、Home 和 End,程序化切换不得改变页面滚动和布局。账号删除必须保留不可撤销确认,并清理正在显示的设备码和本地账号选择。

验证重点

纯逻辑和组件测试使用 Vitest;Oxlint 检查 TypeScript/React 正确性,Prettier 检查格式,构建门禁限制单个 JavaScript chunk 不超过 500 KB。浏览器测试使用 Playwright 覆盖设置布局、键盘操作、隐藏表单隔离、账号删除、窄屏溢出、邮箱掩码、session 失效和跨账号竞态。修改 effect、轮询或异步加载时应覆盖卸载清理、错误状态及旧响应覆盖新状态;修改 CSS 时同时跑 desktop 和 mobile projects。