@cloudbase/auth 2.25.3 → 2.25.5-alpha.0

package/src/index.ts

@@ -1,10 +1,9 @@
 import type { ICloudbase, ICloudbaseConfig, ICloudbasePlatformInfo } from '@cloudbase/types'
 import type { ICloudbaseCache } from '@cloudbase/types/cache'
 import type { ICloudbaseRequest } from '@cloudbase/types/request'
-import type { ICloudbaseAuthConfig, IUser, IUserInfo, ILoginState } from '@cloudbase/types/auth'
+import type { ICloudbaseAuthConfig, IUser, ILoginState } from '@cloudbase/types/auth'
 import type { ICloudbaseComponent } from '@cloudbase/types/component'
-import type { GrantProviderTokenResponse, ProviderSubType } from '@cloudbase/oauth/dist/cjs/auth/models'
-import type { authModels, AuthOptions, Credentials } from '@cloudbase/oauth'
+import type { AuthOptions, Credentials } from '@cloudbase/oauth'
 import {
   CloudbaseOAuth,
   AUTH_API_PREFIX,
@@ -12,8 +11,9 @@ import {
   EVENTS,
   AUTH_STATE_CHANGED_TYPE,
   OAUTH_TYPE,
-  weappJwtDecodeAll,
+  weAppJwtDecodeAll,
   AuthError,
+  authModels,
 } from '@cloudbase/oauth'
 import { useAuthAdapter } from './adapter'
 import {
@@ -272,7 +272,7 @@ export class User implements IUser {
       `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
     ],
   })
-  public async refresh(params?: { version?: string; query?: any }): Promise<IUserInfo> {
+  public async refresh(params?: { version?: string; query?: any }): Promise<authModels.UserInfo> {
     const newUserInfo = await this.oauthInstance.authApi.getUserInfo(params)
     if ((newUserInfo as any).code === 'INVALID_ACCESS_TOKEN') {
       this.setLocalUserInfo({})
@@ -513,7 +513,7 @@ class Auth {
     if (loginState) {
       const userInfo = loginState.user.getLocalUserInfo() as authModels.UserInfo
       await loginState.user.checkLocalInfoAsync()
-      return { ...loginState.user, ...userInfo }
+      return { ...loginState.user, ...userInfo } as unknown as authModels.UserInfo & Partial<User>
     }
     return null
   }
@@ -564,7 +564,7 @@ class Auth {
     const wxInfo = wx.getAccountInfoSync().miniProgram
 
     const mainFunc = async (code) => {
-      let result: GrantProviderTokenResponse | undefined = undefined
+      let result: authModels.GrantProviderTokenResponse | undefined = undefined
       let credentials: Credentials | undefined = undefined
 
       try {
@@ -639,7 +639,7 @@ class Auth {
     const wxInfo = wx.getAccountInfoSync().miniProgram
 
     const mainFunc = async (code) => {
-      let result: GrantProviderTokenResponse | undefined = undefined
+      let result: authModels.GrantProviderTokenResponse | undefined = undefined
 
       try {
         result = await this.oauthInstance.authApi.grantProviderToken({
@@ -682,82 +682,6 @@ class Auth {
     return
   }
 
-  /**
-   * 小程序openId静默登录
-   * @returns {Promise<LoginState>}
-   * @memberof Auth
-   */
-  // @catchErrorsDecorator({
-  //   title: '小程序openId静默登录失败',
-  //   messages: [
-  //     '请确认以下各项：',
-  //     '  1 - 当前环境是否开启了小程序openId静默登录',
-  //     '  2 - 调用 auth().signInWithOpenId() 的语法或参数是否正确',
-  //     `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
-  //   ],
-  // })
-  // public async signInWithOpenId({ useWxCloud = true } = {}): Promise<LoginState> {
-  //   if (!adapterForWxMp.isMatch()) {
-  //     throw Error('wx api undefined')
-  //   }
-  //   const wxInfo = wx.getAccountInfoSync().miniProgram
-
-  //   const mainFunc = async (code) => {
-  //     let result: GrantProviderTokenResponse | undefined = undefined
-  //     let credentials: Credentials | undefined = undefined
-
-  //     try {
-  //       result = await this.oauthInstance.authApi.grantProviderToken(
-  //         {
-  //           provider_id: wxInfo?.appId,
-  //           provider_code: code,
-  //           provider_params: {
-  //             provider_code_type: 'open_id',
-  //             appid: wxInfo?.appId,
-  //           },
-  //         },
-  //         useWxCloud,
-  //       )
-
-  //       if ((result as any)?.error_code || !result.provider_token) {
-  //         throw result
-  //       }
-
-  //       credentials = await this.oauthInstance.authApi.signInWithProvider(
-  //         { provider_token: result.provider_token },
-  //         useWxCloud,
-  //       )
-
-  //       if ((credentials as any)?.error_code) {
-  //         throw credentials
-  //       }
-  //     } catch (error) {
-  //       throw error
-  //     }
-  //     await this.oauthInstance.oauth2client.setCredentials(credentials as Credentials)
-  //   }
-
-  //   await new Promise((resolve, reject) => {
-  //     wx.login({
-  //       success: async (res: { code: string }) => {
-  //         try {
-  //           await mainFunc(res.code)
-  //           resolve(true)
-  //         } catch (error) {
-  //           reject(error)
-  //         }
-  //       },
-  //       fail: (res: any) => {
-  //         const error = new Error(res?.errMsg)
-  //         ;(error as any).code = res?.errno
-  //         reject(error)
-  //       },
-  //     })
-  //   })
-
-  //   return this.createLoginState()
-  // }
-
   /**
    * 小程序unionId静默登录
    * @returns {Promise<LoginState>}
@@ -1044,29 +968,6 @@ class Auth {
     return exist
   }
 
-  /**
-   * 登出
-   */
-  // @catchErrorsDecorator({
-  //   title: '用户登出失败',
-  //   messages: [
-  //     '请确认以下各项：',
-  //     '  1 - 调用 auth().signOut() 的语法或参数是否正确',
-  //     '  2 - 当前用户是否为匿名登录（匿名登录不支持signOut）',
-  //     `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
-  //   ],
-  // })
-  // public async signOut(params?: authModels.SignoutRequest): Promise<void | authModels.SignoutReponse> {
-  //   const { userInfoKey } = this.cache.keys
-  //   const res = await this.oauthInstance.authApi.signOut(params)
-  //   await this.cache.removeStoreAsync(userInfoKey)
-
-  //   eventBus.fire(EVENTS.LOGIN_STATE_CHANGED, { eventType: LOGIN_STATE_CHANGED_TYPE.SIGN_OUT })
-
-  //   eventBus.fire(EVENTS.AUTH_STATE_CHANGED, { event: AUTH_STATE_CHANGED_TYPE.SIGNED_OUT })
-  //   return res
-  // }
-
   /**
    * 获取本地登录态-同步
    */
@@ -1075,7 +976,7 @@ class Auth {
       // async storage的平台调用此API提示
       printWarn(
         ERRORS.INVALID_OPERATION,
-        'current platform\'s storage is asynchronous, please use getLoginState insteed',
+        'current platform\'s storage is asynchronous, please use getLoginState instead',
       )
       return
     }
@@ -1263,7 +1164,7 @@ class Auth {
   public async onLoginStateChanged(callback: Function) {
     this.config.eventBus?.on(EVENTS.LOGIN_STATE_CHANGED, async (params) => {
       // getLoginState会重复触发getCredentials，导致死循环，所以getCredentials出错不再出发getLoginState
-      const loginState =        params?.data?.eventType !== LOGIN_STATE_CHANGED_TYPE.CREDENTIALS_ERROR ? await this.getLoginState() : {}
+      const loginState = params?.data?.eventType !== LOGIN_STATE_CHANGED_TYPE.CREDENTIALS_ERROR ? await this.getLoginState() : {}
       callback.call(this, { ...params, ...loginState })
     })
     // 立刻执行一次回调
@@ -1302,7 +1203,7 @@ class Auth {
       `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
     ],
   })
-  public async getProviderSubType(): Promise<ProviderSubType> {
+  public async getProviderSubType(): Promise<authModels.ProviderSubType> {
     return this.oauthInstance.authApi.getProviderSubType()
   }
 
@@ -1343,6 +1244,12 @@ class Auth {
     username: rawUsername = '',
     bindInfo = undefined,
     loginType = '',
+  }: {
+    verificationInfo?: authModels.GetVerificationResponse
+    verificationCode?: string
+    username?: string
+    bindInfo?: any
+    loginType?: string
   }): Promise<LoginState> {
     try {
       // 1. 验证验证码
@@ -1452,7 +1359,7 @@ class Auth {
     }
   }
 
-  // ========== SbaseApi methods merged below ==========
+  // ========== new auth api methods merged below ==========
 
   /**
    * https://supabase.com/docs/reference/javascript/auth-signinanonymously
@@ -1481,7 +1388,7 @@ class Auth {
    * @param params
    * @returns Promise<SignUpRes>
    */
-  async signUp(params: authModels.SignUpRequest): Promise<SignUpRes> {
+  async signUp(params: authModels.SignUpRequest & { phone?: string }): Promise<SignUpRes> {
     if (params.phone_number || params.verification_code || params.verification_token || params.provider_token) {
       await this.oauthInstance.authApi.signUp(params)
       return this.createLoginState() as any
@@ -1547,7 +1454,7 @@ class Auth {
    *
    * @param params
    */
-  async signOut(params?: authModels.SignoutRequest): Promise<void | authModels.SignoutReponse> {
+  async signOut(params?: authModels.SignoutRequest,): Promise<authModels.SignoutResponse & { data: Object; error: AuthError }> {
     try {
       const { userInfoKey } = this.cache.keys
       const res = await this.oauthInstance.authApi.signOut(params)
@@ -1816,21 +1723,11 @@ class Auth {
     }
   }
 
-  // https://supabase.com/docs/reference/javascript/auth-signinwithsso
-  async signInWithSSO() {
-    //
-  }
-
-  // https://supabase.com/docs/reference/javascript/auth-signinwithweb3
-  async signInWithWeb3() {
-    //
-  }
-
   // https://supabase.com/docs/reference/javascript/auth-getclaims
   async getClaims(): Promise<GetClaimsRes> {
     try {
       const { accessToken } = await this.getAccessToken()
-      const parsedToken = weappJwtDecodeAll(accessToken)
+      const parsedToken = weAppJwtDecodeAll(accessToken)
       return { data: parsedToken, error: null }
     } catch (error) {
       return { data: {}, error: new AuthError(error) }
@@ -1890,12 +1787,14 @@ class Auth {
 
               await this.oauthInstance.authApi.resetPassword({
                 email: isEmail ? emailOrPhone : undefined,
-                phone: !isEmail ? emailOrPhone : undefined,
+                phone_number: !isEmail ? emailOrPhone : undefined,
                 new_password: attributes.password,
                 verification_token: verificationTokenRes.verification_token,
               })
 
-              this.config.eventBus?.fire(EVENTS.AUTH_STATE_CHANGED, { event: AUTH_STATE_CHANGED_TYPE.PASSWORD_RECOVERY })
+              this.config.eventBus?.fire(EVENTS.AUTH_STATE_CHANGED, {
+                event: AUTH_STATE_CHANGED_TYPE.PASSWORD_RECOVERY,
+              })
 
               const res = await this.signInWithPassword({
                 email: isEmail ? emailOrPhone : undefined,
@@ -2087,7 +1986,7 @@ class Auth {
         // 发送验证码
         const verificationInfo = await this.getVerification(verificationParams)
 
-        Object.keys(restParams).length > 0 && await this.updateUserBasicInfo(restParams)
+        Object.keys(restParams).length > 0 && (await this.updateUserBasicInfo(restParams))
 
         extraRes = {
           messageId: verificationInfo.verification_id,
@@ -2158,7 +2057,7 @@ class Auth {
     try {
       const providers = await this.oauthInstance.authApi.getProviders()
 
-      return { data: { identities: providers?.data?.filter(v => !!v.bind) }, error: null }
+      return { data: { identities: providers?.data?.filter(v => !!v.bind) as unknown as GetUserIdentitiesRes['data']['identities'] }, error: null }
     } catch (error) {
       return { data: {}, error: new AuthError(error) }
     }
@@ -2325,7 +2224,7 @@ class Auth {
         refresh_token: { required: true, message: 'Refresh token is required' },
       })
 
-      await this.oauthInstance.oauth2client.refreshToken(params, { throwOnError: true })
+      await this.oauthInstance.oauth2client.refreshToken(params, { throwError: true })
 
       const { data: { session } = {} } = await this.getSession()
 
@@ -2588,13 +2487,13 @@ class Auth {
     return {
       id: userId,
       aud: 'authenticated',
-      role: userInfo.groups,
+      role: userInfo.groups.map(group => (typeof group === 'string' ? group : group.id)),
       email: email || '',
       email_confirmed_at: userInfo?.email_verified ? userInfo.created_at : userInfo.created_at,
       phone,
       phone_confirmed_at: phone ? userInfo.created_at : undefined,
       confirmed_at: userInfo.created_at,
-      last_sign_in_at: userInfo.last_sign_in_at,
+      last_sign_in_at: (userInfo as any).last_sign_in_at,
       app_metadata: {
         provider: userInfo.loginType?.toLowerCase() || 'cloudbase',
         providers: [userInfo.loginType?.toLowerCase() || 'cloudbase'],
@@ -2626,7 +2525,7 @@ class Auth {
           provider: p.id || 'cloudbase',
           created_at: userInfo.created_at,
           updated_at: userInfo.updated_at,
-          last_sign_in_at: userInfo.last_sign_in_at,
+          last_sign_in_at: (userInfo as any).last_sign_in_at,
         })) || [],
       created_at: userInfo.created_at,
       updated_at: userInfo.updated_at,
@@ -2656,7 +2555,6 @@ class Auth {
     }
   }
 
-
   private async init(): Promise<{ error: Error | null }> {
     try {
       const credentials: Credentials = await this.oauthInstance.oauth2client.localCredentials.getCredentials()
@@ -2677,7 +2575,7 @@ Partial<AuthOptions> & {
 }
 
 export function generateAuthInstance(
-  config: TInitAuthOptions,
+  config: TInitAuthOptions & { sdkVersion?: string },
   options?: {
     clientId: ICloudbaseConfig['clientId']
     env: ICloudbaseConfig['env']
@@ -2732,8 +2630,7 @@ export function generateAuthInstance(
     persistence: config.persistence,
     debug,
     cache:
-      cache
-      || new CloudbaseCache({
+      cache || new CloudbaseCache({
         persistence: config.persistence,
         keys: { userInfoKey: `user_info_${env}` },
         platformInfo: platform,

package/src/type.ts

@@ -1,26 +1,5 @@
 import type { authModels, OAUTH_TYPE } from '@cloudbase/oauth'
-
-class AuthError extends Error {
-  /**
-   * Error code associated with the error. Most errors coming from
-   * HTTP responses will have a code, though some errors that occur
-   * before a response is received will not have one present. In that
-   * case {@link #status} will also be undefined.
-   */
-  code: (string & {}) | undefined
-
-  /** HTTP status code that caused the error. */
-  status: number | undefined
-
-  protected __isAuthError = true
-
-  constructor(error) {
-    super(error.error_description || error.message)
-    this.name = 'AuthError'
-    this.status = error.error
-    this.code = error.error_code
-  }
-}
+import { AuthError } from '@cloudbase/oauth'
 
 
 export interface SignInAnonymouslyReq {
@@ -62,10 +41,10 @@ export declare type User = {
 }
 
 export declare type Session = {
-  access_token: string // 访问令牌
-  refresh_token: string // 刷新令牌
-  expires_in: number // 过期时间（秒）
-  token_type: string // 令牌类型
+  access_token?: string // 访问令牌
+  refresh_token?: string // 刷新令牌
+  expires_in?: number // 过期时间（秒）
+  token_type?: string // 令牌类型
   user: User // 用户信息
 }
 
@@ -200,7 +179,6 @@ export interface GetUserIdentitiesRes {
       name: string // 身份源名称
       picture: string // 头像URL
     }>
-    | authModels.ProvidersResponse['data']
   }
   error: AuthError | null // 错误信息，成功时为null
 }