@cloudbase/auth 2.24.0 → 2.24.2

package/SbaseApi.md

@@ -105,7 +105,7 @@ async function registerUser(email, password, nickname, verificationCode) {
     console.log('验证码已发送，等待验证...')
 
     // 第二步：验证验证码并完成注册
-    const { data: loginData, error: loginError } = await data.verify(verificationCode)
+    const { data: loginData, error: loginError } = await data.verifyOtp({ token: verificationCode })
 
     if (loginError) {
       console.error('验证失败:', loginError.message)
@@ -310,7 +310,7 @@ class PhoneLoginPage {
     this.hideError()
 
     try {
-      const { data, error } = await this.verifyFunction(code)
+      const { data, error } = await this.verifyFunction({ token: code })
 
       if (error) {
         this.handleVerifyError(error)
@@ -332,7 +332,7 @@ class PhoneLoginPage {
 
   // 处理发送验证码成功
   handleSendCodeSuccess(data) {
-    this.verifyFunction = data.verify
+    this.verifyFunction = data.verifyOtp
     
     // 显示验证码输入区域
     document.getElementById('verificationSection').style.display = 'block'
@@ -485,7 +485,7 @@ class SecurePhoneLogin {
       throw new Error('验证码格式错误，请输入6位数字')
     }
 
-    const { data, error } = await verifyFunction(code)
+    const { data, error } = await verifyFunction({ token: code })
 
     if (error) {
       throw error
@@ -699,7 +699,7 @@ Promise<SignUpRes>
 
 | 字段名 | 类型 | 描述 |
 |-------|------|------|
-| data.verify | function | 验证码回调函数，支持messageId参数 |
+| data.verifyOtp | function | 验证码回调函数，参数为 `{ token: string, messageId?: string }` |
 | error | AuthError \| null | 错误信息，成功时为null |
 
 **返回值定义**
@@ -707,7 +707,7 @@ Promise<SignUpRes>
 ```typescript
 interface SignUpRes {
   data: {
-    verify: (code: string, messageId?: string) => Promise<SignInRes>
+    verifyOtp: (params: { token: string, messageId?: string }) => Promise<SignInRes>
   }
   error: AuthError | null
 }
@@ -735,7 +735,7 @@ if (error) {
   const verificationCode = '123456' // 用户输入的验证码
 
   // 第三步：智能验证流程（自动判断用户存在性）
-  const { data: loginData, error: loginError } = await data.verify(verificationCode)
+  const { data: loginData, error: loginError } = await data.verifyOtp({ token: verificationCode })
 
   if (loginError) {
     console.error('验证失败:', loginError.message)
@@ -767,7 +767,7 @@ if (error) {
   const verificationCode = '123456' // 用户输入的验证码
 
   // 第三步：智能验证流程（自动判断用户存在性）
-  const { data: loginData, error: loginError } = await data.verify(verificationCode)
+  const { data: loginData, error: loginError } = await data.verifyOtp({ token: verificationCode })
 
   if (loginError) {
     console.error('操作失败:', loginError.message)
@@ -801,7 +801,7 @@ async function startRegistration(email, password, nickname) {
     return false
   } else {
     console.log('验证码已发送')
-    signUpVerify = data.verify
+    signUpVerify = data.verifyOtp
 
     // 显示验证码输入框
     document.getElementById('verificationSection').style.display = 'block'
@@ -820,7 +820,7 @@ async function completeRegistration(verificationCode) {
     return false
   }
 
-  const { data, error } = await signUpVerify(verificationCode)
+  const { data, error } = await signUpVerify({ token: verificationCode })
 
   if (error) {
     console.error('验证失败:', error.message)
@@ -1274,7 +1274,7 @@ Promise<SignInWithOtpRes>
 
 | 字段名 | 类型 | 描述 |
 |-------|------|------|
-| data.verify | function | 验证码回调函数，支持messageId参数 |
+| data.verifyOtp | function | 验证码回调函数，参数为 `{ token: string, messageId?: string }` |
 | error | AuthError \| null | 错误信息，成功时为null |
 
 **返回值定义**
@@ -1282,7 +1282,7 @@ Promise<SignInWithOtpRes>
 ```typescript
 interface SignInWithOtpRes {
   data: {
-    verify: (code: string, messageId?: string) => Promise<SignInRes>
+    verifyOtp: (params: { token: string, messageId?: string }) => Promise<SignInRes>
   }
   error: AuthError | null
 }
@@ -1312,7 +1312,7 @@ if (error) {
   console.log('验证码已发送，等待用户输入...')
 
   // 用户输入验证码后验证
-  const { data: loginData, error: loginError } = await data.verify('123456')
+  const { data: loginData, error: loginError } = await data.verifyOtp({ token: '123456' })
 
   if (loginError) {
     console.error('验证失败:', loginError.message)
@@ -1337,7 +1337,7 @@ if (error) {
   console.log('邮箱验证码已发送，请查收邮件...')
 
   // 用户从邮箱获取验证码后验证
-  const { data: loginData, error: loginError } = await data.verify('654321')
+  const { data: loginData, error: loginError } = await data.verifyOtp({ token: '654321' })
 
   if (loginError) {
     console.error('验证失败:', loginError.message)
@@ -1388,7 +1388,7 @@ try {
   }
 
   // 验证验证码
-  const { data: loginData, error: loginError } = await data.verify('123456')
+  const { data: loginData, error: loginError } = await data.verifyOtp({ token: '123456' })
 
   if (loginError) {
     console.error('验证失败:', loginError.message)
@@ -2923,11 +2923,12 @@ if (refreshedData) {
 更新当前登录用户的信息。
 
 - 不支持更新密码，更新密码请使用 [resetPasswordForEmail](#resetpasswordforemail) 或 [reauthenticate](#reauthenticate)
+- **更新邮箱或手机号时**，需要先发送验证码，然后通过返回的 `verifyOtp` 回调进行验证
 
 **方法签名**
 
 ```typescript
-async updateUser(params: UpdateUserReq): Promise<GetUserRes>
+async updateUser(params: UpdateUserReq): Promise<GetUserRes | UpdateUserWithVerificationRes>
 ```
 
 **描述**
@@ -2935,14 +2936,15 @@ async updateUser(params: UpdateUserReq): Promise<GetUserRes>
 - 更新当前登录用户的基本信息和元数据
 - 支持更新邮箱、手机号、用户名、昵称、头像等
 - 需要用户已登录状态才能更新信息
-- 更新成功后返回更新后的用户信息
+- **更新邮箱或手机号时**：返回 `verifyOtp` 回调函数，需要用户输入验证码后调用该回调完成验证
+- **更新其他字段时**：直接返回更新后的用户信息
 
 **参数**
 
 | 参数名 | 类型 | 必选 | 描述 |
 |-------|------|------|------|
-| email | string | 可选 | 邮箱地址 |
-| phone | string | 可选 | 手机号码 |
+| email | string | 可选 | 邮箱地址（需要验证码验证） |
+| phone | string | 可选 | 手机号码（需要验证码验证） |
 | username | string | 可选 | 用户名称，长度 5-24 位，支持中英文、数字、特殊字符（仅支持_-），不支持中文 |
 | description | string | 可选 | 用户描述信息 |
 | avatar_url | string | 可选 | 头像URL地址 |
@@ -2952,11 +2954,22 @@ async updateUser(params: UpdateUserReq): Promise<GetUserRes>
 **返回类型**
 
 ```typescript
-Promise<GetUserRes>
+Promise<GetUserRes | UpdateUserWithVerificationRes>
 ```
 
 **返回值**
 
+当更新邮箱或手机号时：
+
+| 字段名 | 类型 | 描述 |
+|-------|------|------|
+| data.user | User | 当前用户信息（验证前） |
+| data.messageId | string | 验证码消息ID |
+| data.verifyOtp | function | 验证码回调函数，参数为 `{ email?: string, phone?: string, token: string }` |
+| error | AuthError \| null | 错误信息，成功时为null |
+
+当更新其他字段时：
+
 | 字段名 | 类型 | 描述 |
 |-------|------|------|
 | data.user | User | 更新后的用户详细信息 |
@@ -2965,6 +2978,7 @@ Promise<GetUserRes>
 **返回值定义**
 
 ```typescript
+// 更新其他字段时的返回值
 interface GetUserRes {
   data: {
     user?: User
@@ -2972,6 +2986,16 @@ interface GetUserRes {
   error: AuthError | null
 }
 
+// 更新邮箱或手机号时的返回值
+interface UpdateUserWithVerificationRes {
+  data: {
+    user?: User
+    messageId?: string
+    verifyOtp?: (params: { email?: string, phone?: string, token: string }) => Promise<GetUserRes>
+  }
+  error: AuthError | null
+}
+
 interface User {
   id: any
   aud: string
@@ -3012,25 +3036,82 @@ interface AuthError extends Error {
 
 **示例**
 
-**示例 1：更新基本用户信息**
+**示例 1：更新基本用户信息（无需验证码）**
 
 ```typescript
 const { data, error } = await auth.updateUser({
-  email: 'newemail@example.com',
   nickname: '新昵称',
   gender: 'MALE',
+  avatar_url: 'https://example.com/avatar.jpg',
 })
 
 if (error) {
   console.error('更新用户信息失败:', error.message)
 } else {
   console.log('用户信息已更新:', data.user)
-  console.log('新邮箱:', data.user?.email)
   console.log('新昵称:', data.user?.user_metadata?.nickName)
 }
 ```
 
-**示例 2：更新头像和描述**
+**示例 2：更新邮箱（需要验证码验证）**
+
+```typescript
+// 第一步：发起邮箱更新，系统会发送验证码到新邮箱
+const { data, error } = await auth.updateUser({
+  email: 'newemail@example.com',
+})
+
+if (error) {
+  console.error('发送验证码失败:', error.message)
+} else {
+  console.log('验证码已发送到新邮箱，等待用户输入...')
+
+  // 第二步：用户输入验证码后，调用 verifyOtp 回调完成验证
+  const verificationCode = '123456' // 用户输入的验证码
+
+  const { data: verifyData, error: verifyError } = await data.verifyOtp({
+    email: 'newemail@example.com',
+    token: verificationCode,
+  })
+
+  if (verifyError) {
+    console.error('验证失败:', verifyError.message)
+  } else {
+    console.log('邮箱更新成功:', verifyData.user?.email)
+  }
+}
+```
+
+**示例 3：更新手机号（需要验证码验证）**
+
+```typescript
+// 第一步：发起手机号更新，系统会发送验证码到新手机号
+const { data, error } = await auth.updateUser({
+  phone: '13800138001',
+})
+
+if (error) {
+  console.error('发送验证码失败:', error.message)
+} else {
+  console.log('验证码已发送到新手机号，等待用户输入...')
+
+  // 第二步：用户输入验证码后，调用 verifyOtp 回调完成验证
+  const verificationCode = '123456' // 用户输入的验证码
+
+  const { data: verifyData, error: verifyError } = await data.verifyOtp({
+    phone: '13800138001',
+    token: verificationCode,
+  })
+
+  if (verifyError) {
+    console.error('验证失败:', verifyError.message)
+  } else {
+    console.log('手机号更新成功:', verifyData.user?.phone)
+  }
+}
+```
+
+**示例 4：更新头像和描述**
 
 ```typescript
 const { data, error } = await auth.updateUser({
@@ -3051,7 +3132,7 @@ if (error) {
 }
 ```
 
-**示例 3：用户资料编辑页面**
+**示例 5：用户资料编辑页面**
 
 ```typescript
 async function saveUserProfile(formData) {
@@ -3088,7 +3169,7 @@ document.getElementById('profileForm').addEventListener('submit', async (e) => {
 })
 ```
 
-**示例 4：错误处理**
+**示例 6：错误处理**
 
 ```typescript
 try {
@@ -4897,7 +4978,7 @@ interface AuthError extends Error {
 const { data, error } = await auth.signInWithOtp({ phone: '13800138000' })
 
 // 验证码校验回调
-let signUpVerify = data.verify
+let signUpVerify = data.verifyOtp
 
 // 重新发送验证码，获取新的messageId
 const { data: resendData, error: resendError } = await auth.resend({
@@ -4916,7 +4997,7 @@ if (resendError) {
   const messageId = resendData.messageId // 新的messageId
 
   // 使用新的messageId进行验证
-  const { data: loginData, error: loginError } = await signUpVerify(verificationCode, messageId)
+  const { data: loginData, error: loginError } = await signUpVerify({ token: verificationCode, messageId })
 
   if (loginError) {
     console.error('验证失败:', loginError.message)
@@ -5749,7 +5830,7 @@ interface ResendRes {
 // OTP登录响应参数
 interface SignInWithOtpRes {
   data: {
-    verify?: (code: string, messageId?: string) => Promise<SignInRes> // 验证码回调函数，支持messageId参数
+    verifyOtp?: (params: { token: string, messageId?: string }) => Promise<SignInRes> // 验证码回调函数
   }
   error: AuthError | null // 错误信息，成功时为null
 }
@@ -5757,7 +5838,17 @@ interface SignInWithOtpRes {
 // 用户注册响应参数
 interface SignUpRes {
   data: {
-    verify?: (code: string, messageId?: string) => Promise<SignInRes> // 验证码回调函数，支持messageId参数
+    verifyOtp?: (params: { token: string, messageId?: string }) => Promise<SignInRes> // 验证码回调函数
+  }
+  error: AuthError | null
+}
+
+// 用户信息更新响应参数（当更新邮箱或手机号时）
+interface UpdateUserWithVerificationRes {
+  data: {
+    user?: User // 当前用户信息
+    messageId?: string // 验证码消息ID
+    verifyOtp?: (params: { email?: string, phone?: string, token: string }) => Promise<GetUserRes> // 验证码回调函数
   }
   error: AuthError | null
 }