@cloudbase/wx-cloud-client-sdk 1.8.1 → 1.8.2

package/README.md

@@ -116,11 +116,31 @@ const auth = client.auth;
 // 微信小程序 OpenID 静默登录，用户不存在则注册成外部注册用户
 await auth.signInWithOpenId();
 
+// 更新用户信息
+const { data, error } = await auth.updateUser({
+  nickname: '新昵称',
+  gender: 'MALE',
+});
+
+// 更新 email 或 phone（需要验证）
+const { data, error } = await app.auth.updateUser({
+  email: 'new@example.com',
+});
+
+// 调用 verifyOtp 回调验证
+await data.verifyOtp({ email: 'new@example.com', token: '123456' });
+
+// 获取当前用户信息
+const { data, error } = await auth.getUser();
+
 // 获取登录状态
-const { data } = auth.getSession();
+const { data, error } = auth.getSession();
 
 // 登出
 await auth.signOut();
+
+// 刷新登录状态
+await auth.refreshSession();
 ```
 
 ## API
@@ -134,6 +154,15 @@ await auth.signOut();
 | cloud         | CloudBaseInstance | 是   | 微信云开发实例 |
 | options.envId | string            | 否   | 环境 ID        |
 
+### 认证方法
+
+- `signInWithOpenId()` - 微信小程序 OpenID 静默登录，用户不存在则注册成外部注册用户
+- `updateUser(params)` - 更新用户信息
+- `getUser()` - 获取当前用户信息
+- `getSession()` - 获取登录状态
+- `refreshSession()` - 刷新登录状态
+- `signOut()` - 登出
+
 ### 数据模型方法
 
 - `create(params)` - 创建单条数据

package/lib/types/index.d.ts

@@ -719,9 +719,11 @@ export type CloudBaseInstance = {
 export type IMySqlClient = (options?: IMySqlOptions) => MySqlClient;
 export interface Auth {
     signInWithOpenId: AuthInstance['signInWithOpenId'];
+    updateUser: AuthInstance['updateUser'];
     getUser: AuthInstance['getUser'];
     getSession: AuthInstance['getSession'];
     refreshSession: AuthInstance['refreshSession'];
+    signOut: AuthInstance['signOut'];
 }
 /**
  * 扩展的云实例接口，扩展了云函数调用接口并包含ORM客户端。