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

package/README.md

@@ -18,7 +18,6 @@ import { init } from '@cloudbase/wx-cloud-client-sdk';
 // 使用微信云开发实例初始化
 const client = init(wx.cloud, {
   envId: 'your-env-id',
-  accessKey: 'your-access-key', // 可选，客户端 Publishable Key
 });
 ```
 
@@ -117,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
@@ -130,11 +149,19 @@ await auth.signOut();
 
 初始化 SDK（使用云函数调用）。
 
-| 参数              | 类型              | 必填 | 说明                   |
-| ----------------- | ----------------- | ---- | ---------------------- |
-| cloud             | CloudBaseInstance | 是   | 微信云开发实例         |
-| options.envId     | string            | 否   | 环境 ID                |
-| options.accessKey | string            | 否   | 客户端 Publishable Key |
+| 参数          | 类型              | 必填 | 说明           |
+| ------------- | ----------------- | ---- | -------------- |
+| cloud         | CloudBaseInstance | 是   | 微信云开发实例 |
+| options.envId | string            | 否   | 环境 ID        |
+
+### 认证方法
+
+- `signInWithOpenId()` - 微信小程序 OpenID 静默登录，用户不存在则注册成外部注册用户
+- `updateUser(params)` - 更新用户信息
+- `getUser()` - 获取当前用户信息
+- `getSession()` - 获取登录状态
+- `refreshSession()` - 刷新登录状态
+- `signOut()` - 登出
 
 ### 数据模型方法
 

package/lib/auth/index.d.ts

@@ -1,6 +1,4 @@
-import { CloudBaseInstance } from '../types';
-import { Auth } from '@cloudbase/auth';
+import { CloudBaseInstance, Auth } from '../types';
 export declare const generateAuthClient: (cloud: CloudBaseInstance, options?: {
     envId?: string;
-    accessKey?: string;
 }) => Auth;

package/lib/index.d.ts

@@ -11,7 +11,6 @@ export declare function initHTTPOverCallFunction(cloud: CloudBaseInstance, optio
 }): ExtendedCloudBaseInstance;
 export declare function init(cloud: CloudBaseInstance, options?: {
     envId?: string;
-    accessKey?: string;
 }): ExtendedCloudBaseInstance;
 declare function generateMySQLClient(cloud: CloudBaseInstance, options?: {
     envId?: string;

package/lib/types/index.d.ts

@@ -1,6 +1,6 @@
 import { SDKRequestInterface } from '@cloudbase/adapter-interface';
 import { MySqlClient } from '../db/mysql';
-import { Auth } from '@cloudbase/auth';
+import { Auth as AuthInstance } from '@cloudbase/auth';
 /**
  * 基础 Model 类型定义
  */
@@ -717,6 +717,14 @@ export type CloudBaseInstance = {
     auth: any;
 };
 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客户端。
  * @hidden