1.1.0 升级说明
本文对应 @hfyidu/api@1.1.0,重点说明认证刷新接入与旧项目迁移。
安装指定版本
bash
pnpm add @hfyidu/api@1.1.0认证刷新
AuthBridge 支持两个可选回调:
| 回调 | 行为 |
|---|---|
loginParamsBuilder | 返回登录参数的 Promise,SDK 使用 await 等待参数再发起登录请求;当前不传入调用参数 |
loginRefreshHandler | 自动登录成功后接收完整 UserLoginDto,同步更新业务状态;SDK 随后调用 setToken |
旧项目的同步 builder 请改为 async 函数,以符合当前类型定义。 微信小程序应在 builder 内获取新的微信 code,返回 theatre_code 等后台要求的字段。 配置示例、Pinia 安装顺序和并发规则见快速开始。
认证错误登录刷新与自动续期是两个流程:认证错误触发登录并重试原请求; 业务码 100000 则读取 automatic-renewal-token 响应头,仅更新 token 后重试。 并发请求共享登录刷新 Promise;旧 token 的迟到响应不会覆盖已更新的 token。
旧调用迁移
httpApi.setDeviceId()和httpApi.device已不在当前 API 中; 设备信息通过登录参数传递,业务请求不再默认添加X-Device-UID。httpApi.handleTokenRefresh()不再是公开方法,刷新由httpApi.request()内部处理。headerBuilder(header, tokenRequired)的第二个参数用于控制 token 请求头; 普通业务调用建议使用request(),其tokenRequired默认是true。HttpApiConfig可配置identityAppId和loginPath;默认登录路径是/user/login。- SDK 不负责状态持久化,需由业务侧的
setToken、刷新回调与持久化插件完成。
当前 PayType 掌中付成员使用以下名称,旧代码请对应调整:
| 旧名称 | 当前名称 | value |
|---|---|---|
ZZF_JSAPI | ZZF_WX_JSAPI | 50 |
ZZF_MP | ZZF_WX_MP | 51 |
ZZF_WX | ZZF_WX_MINI | 52 |
ZZF_H5_WX | ZZF_WX_H5 | 53 |
ZZF_ZFB | ZZF_ZFB_APP | 54 |
完整枚举见订单/支付。 UserLoginDto 的 state 和 expiresIn 说明已同步到用户领域。
Monorepo 本地调试
workspace:* 链接的是 packages/api/dist 构建产物,修改源码后先构建 API, 再重启业务项目开发进程:
bash
pnpm --filter @hfyidu/api build
pnpm --filter wxmini dev:mp-weixin仅重新编译小程序或刷新页面,不能替代 API 的构建。旧产物中的同步 builder 调用 可能把 Promise 作为登录请求体提交,表现为登录参数为空或缺少 theatre_code。