@cloudbase/auth 2.4.5-beta.0 → 2.5.0-beta.0

package/src/index.ts

@@ -1,47 +1,47 @@
-import { ICloudbase } from '@cloudbase/types';
-import { utils, constants, helpers, events } from '@cloudbase/utilities';
-import { ICloudbaseCache } from '@cloudbase/types/cache';
-import { ICloudbaseRequest } from '@cloudbase/types/request';
-import { ICloudbaseAuthConfig, IUser, IUserInfo, ILoginState } from '@cloudbase/types/auth';
-import { ICloudbaseComponent } from '@cloudbase/types/component';
+import { ICloudbase } from '@cloudbase/types'
+import { utils, constants, helpers, events } from '@cloudbase/utilities'
+import { ICloudbaseCache } from '@cloudbase/types/cache'
+import { ICloudbaseRequest } from '@cloudbase/types/request'
+import { ICloudbaseAuthConfig, IUser, IUserInfo, ILoginState } from '@cloudbase/types/auth'
+import { ICloudbaseComponent } from '@cloudbase/types/component'
 
 import { authModels, CloudbaseOAuth } from '@cloudbase/oauth'
 
-declare const cloudbase: ICloudbase;
+declare const cloudbase: ICloudbase
 
-const { printWarn, throwError } = utils;
-const { ERRORS, COMMUNITY_SITE_URL } = constants;
-const { catchErrorsDecorator } = helpers;
-const { CloudbaseEventEmitter } = events;
+const { printWarn, throwError } = utils
+const { ERRORS, COMMUNITY_SITE_URL } = constants
+const { catchErrorsDecorator } = helpers
+const { CloudbaseEventEmitter } = events
 
-const COMPONENT_NAME = 'auth';
+const COMPONENT_NAME = 'auth'
 
 const EVENTS = {
   // 登录态改变后触发
   LOGIN_STATE_CHANGED: 'loginStateChanged',
-};
+}
 
 interface UserInfo {
-  uid?: string;
-  gender?: string;
-  picture?: string;
-  email?: string;
-  email_verified?: boolean;
-  phone_number?: string;
-  username?: string;
-  name?: string;
-  birthdate?: string;
-  zoneinfo?: string;
-  locale?: string;
-  sub?: string;
-  created_from?: string;
+  uid?: string
+  gender?: string
+  picture?: string
+  email?: string
+  email_verified?: boolean
+  phone_number?: string
+  username?: string
+  name?: string
+  birthdate?: string
+  zoneinfo?: string
+  locale?: string
+  sub?: string
+  created_from?: string
 }
 
-const eventBus = new CloudbaseEventEmitter();
+const eventBus = new CloudbaseEventEmitter()
 
 interface IUserOptions {
-  cache: ICloudbaseCache;
-  // request: ICloudbaseRequest;
+  cache: ICloudbaseCache
+  // request: ICloudbaseRequest
   oauthInstance: CloudbaseOAuth
 }
 
@@ -50,68 +50,68 @@ class User implements IUser {
   public gender?: string;
   public picture?: string;
   public email?: string;
-  public email_verified?: boolean;
-  public phone_number?: string;
+  public emailVerified?: boolean;
+  public phoneNumber?: string;
   public username?: string;
   public name?: string;
   public providers?: {
-    id?: string;
-    provider_user_id?: string;
-    name?: string;
-  }[]
+    id?: string
+    providerUserId?: string
+    name?: string
+  }[];
   public birthdate?: string;
   public zoneinfo?: string;
   public locale?: string;
   public sub?: string;
-  public created_from?: string;
+  public createdFrom?: string;
 
-  private _cache: ICloudbaseCache;
-  private _oauthInstance: CloudbaseOAuth // CloudbaseOAuth 类型
+  private cache: ICloudbaseCache;
+  private oauthInstance: CloudbaseOAuth; // CloudbaseOAuth 类型
 
   constructor(options: IUserOptions) {
-    const { cache, oauthInstance } = options;
-    this._cache = cache;
-    this._oauthInstance = oauthInstance
+    const { cache, oauthInstance } = options
+    this.cache = cache
+    this.oauthInstance = oauthInstance
 
-    this._setUserInfo();
+    this.setUserInfo()
   }
   /**
    * 获取本地用户信息-同步
    */
   public async checkLocalInfo() {
-    this.uid = this._getLocalUserInfo('uid') as string;
-    this.gender = this._getLocalUserInfo('gender') as string;
-    this.picture = this._getLocalUserInfo('picture') as string;
-    this.email = this._getLocalUserInfo('email') as string;
-    this.email_verified = this._getLocalUserInfo('email_verified') as boolean;
-    this.phone_number = this._getLocalUserInfo('phone_number') as string
-    this.username = this._getLocalUserInfo('username') as string
-    this.name = this._getLocalUserInfo('name') as string
-    this.birthdate = this._getLocalUserInfo('birthdate') as string
-    this.zoneinfo = this._getLocalUserInfo('zoneinfo') as string
-    this.locale = this._getLocalUserInfo('locale') as string
-    this.sub = this._getLocalUserInfo('sub') as string
-    this.created_from = this._getLocalUserInfo('created_from') as string
-    this.providers = this._getLocalUserInfo('providers') as any
+    this.uid = this.getLocalUserInfo('uid') as string
+    this.gender = this.getLocalUserInfo('gender') as string
+    this.picture = this.getLocalUserInfo('picture') as string
+    this.email = this.getLocalUserInfo('email') as string
+    this.emailVerified = this.getLocalUserInfo('email_verified') as boolean
+    this.phoneNumber = this.getLocalUserInfo('phone_number') as string
+    this.username = this.getLocalUserInfo('username') as string
+    this.name = this.getLocalUserInfo('name') as string
+    this.birthdate = this.getLocalUserInfo('birthdate') as string
+    this.zoneinfo = this.getLocalUserInfo('zoneinfo') as string
+    this.locale = this.getLocalUserInfo('locale') as string
+    this.sub = this.getLocalUserInfo('sub') as string
+    this.createdFrom = this.getLocalUserInfo('created_from') as string
+    this.providers = this.getLocalUserInfo('providers') as any
   }
   /**
    * 获取本地用户信息-异步
    */
   public async checkLocalInfoAsync() {
-    this.uid = await this._getLocalUserInfoAsync('uid');
-    this.gender = await this._getLocalUserInfoAsync('gender');
-    this.picture = this._getLocalUserInfo('picture') as string;
-    this.email = await this._getLocalUserInfoAsync('email');
-    this.email_verified = this._getLocalUserInfo('email_verified') as boolean;
-    this.phone_number = this._getLocalUserInfo('phone_number') as string
-    this.username = await this._getLocalUserInfoAsync('username')
-    this.name = this._getLocalUserInfo('name') as string
-    this.birthdate = this._getLocalUserInfo('birthdate') as string
-    this.zoneinfo = this._getLocalUserInfo('zoneinfo') as string
-    this.locale = this._getLocalUserInfo('locale') as string
-    this.sub = this._getLocalUserInfo('sub') as string
-    this.created_from = this._getLocalUserInfo('created_from') as string
-    this.providers = this._getLocalUserInfo('providers') as any
+    this.uid = await this.getLocalUserInfoAsync('uid')
+    this.gender = await this.getLocalUserInfoAsync('gender')
+    this.picture = this.getLocalUserInfo('picture') as string
+    this.email = await this.getLocalUserInfoAsync('email')
+    this.emailVerified = this.getLocalUserInfo('email_verified') as boolean
+    this.phoneNumber = this.getLocalUserInfo('phone_number') as string
+    this.username = await this.getLocalUserInfoAsync('username')
+    this.name = this.getLocalUserInfo('name') as string
+    this.birthdate = this.getLocalUserInfo('birthdate') as string
+    this.zoneinfo = this.getLocalUserInfo('zoneinfo') as string
+    this.locale = this.getLocalUserInfo('locale') as string
+    this.sub = this.getLocalUserInfo('sub') as string
+    this.createdFrom = this.getLocalUserInfo('created_from') as string
+    this.providers = this.getLocalUserInfo('providers') as any
   }
 
 
@@ -125,14 +125,14 @@ class User implements IUser {
       '请确认以下各项：',
       '  1 - 调用 User.update() 的语法或参数是否正确',
       '  2 - 用户信息中是否包含非法值',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async update(userInfo: authModels.UserProfile): Promise<void> {
-    // const { name, gender, avatarUrl, province, country, city } = userInfo;
-    const newUserInfo = await this._oauthInstance.authApi.setUserProfile({ ...userInfo })
+    // const { name, gender, avatarUrl, province, country, city } = userInfo
+    const newUserInfo = await this.oauthInstance.authApi.setUserProfile({ ...userInfo })
 
-    this._setLocalUserInfo(newUserInfo);
+    this.setLocalUserInfo(newUserInfo)
   }
   /**
    * 更新密码
@@ -145,13 +145,13 @@ class User implements IUser {
       '请确认以下各项：',
       '  1 - 调用 User.updatePassword() 的语法或参数是否正确',
       '  3 - 新密码中是否包含非法字符',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public updatePassword(newPassword: string, oldPassword: string) {
-    return this._oauthInstance.authApi.updatePasswordByOld({
+    return this.oauthInstance.authApi.updatePasswordByOld({
       old_password: oldPassword,
-      new_password: newPassword
+      new_password: newPassword,
     })
   }
 
@@ -165,16 +165,16 @@ class User implements IUser {
       '请确认以下各项：',
       '  1 - 调用 User.updateUsername() 的语法或参数是否正确',
       '  2 - 当前环境是否开通了用户名密码登录',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public updateUsername(username: string) {
     if (typeof username !== 'string') {
-      throwError(ERRORS.INVALID_PARAMS, 'username must be a string');
+      throwError(ERRORS.INVALID_PARAMS, 'username must be a string')
     }
 
     return this.update({
-      username
+      username,
     })
   }
 
@@ -186,31 +186,31 @@ class User implements IUser {
     messages: [
       '请确认以下各项：',
       '  1 - 调用 User.refresh() 的语法或参数是否正确',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async refresh(): Promise<IUserInfo> {
-    const newUserInfo = await this._oauthInstance.authApi.getUserInfo()
-    this._setLocalUserInfo(newUserInfo);
-    return newUserInfo;
+    const newUserInfo = await this.oauthInstance.authApi.getUserInfo()
+    this.setLocalUserInfo(newUserInfo)
+    return newUserInfo
   }
 
-  private _getLocalUserInfo(key: string): string | boolean {
-    const { userInfoKey } = this._cache.keys;
-    const userInfo = this._cache.getStore(userInfoKey);
-    return userInfo[key];
+  private getLocalUserInfo(key: string): string | boolean {
+    const { userInfoKey } = this.cache.keys
+    const userInfo = this.cache.getStore(userInfoKey)
+    return userInfo[key]
   }
 
-  private async _getLocalUserInfoAsync(key: string): Promise<string> {
-    const { userInfoKey } = this._cache.keys;
-    const userInfo = await this._cache.getStoreAsync(userInfoKey);
-    return userInfo[key];
+  private async getLocalUserInfoAsync(key: string): Promise<string> {
+    const { userInfoKey } = this.cache.keys
+    const userInfo = await this.cache.getStoreAsync(userInfoKey)
+    return userInfo[key]
   }
 
-  private _setUserInfo() {
-    const { userInfoKey } = this._cache.keys;
-    const userInfo = this._cache.getStore(userInfoKey);
-    [
+  private setUserInfo() {
+    const { userInfoKey } = this.cache.keys
+    const userInfo = this.cache.getStore(userInfoKey)
+    ;[
       'uid',
       'email',
       'name',
@@ -224,65 +224,64 @@ class User implements IUser {
       'sub',
       'created_from',
       'providers',
-      'username'
-    ].forEach(infoKey => {
-      this[infoKey] = userInfo[infoKey];
-    });
+      'username',
+    ].forEach((infoKey) => {
+      this[infoKey] = userInfo[infoKey]
+    })
   }
 
-  private _setLocalUserInfo(userInfo: any) {
-    const { userInfoKey } = this._cache.keys;
-    this._cache.setStore(userInfoKey, userInfo);
-    this._setUserInfo();
+  private setLocalUserInfo(userInfo: any) {
+    const { userInfoKey } = this.cache.keys
+    this.cache.setStore(userInfoKey, userInfo)
+    this.setUserInfo()
   }
 }
 interface ILoginStateOptions extends IUserOptions {
-  envId: string;
+  envId: string
 }
 export class LoginState implements ILoginState {
   public user: IUser;
-  public oauthLoginState: any
+  public oauthLoginState: any;
 
-  private _oauthInstance: CloudbaseOAuth
-  private _cache: ICloudbaseCache;
+  private oauthInstance: CloudbaseOAuth;
+  private cache: ICloudbaseCache;
 
   constructor(options: ILoginStateOptions) {
-    const { envId, cache, oauthInstance } = options;
+    const { envId, cache, oauthInstance } = options
     if (!envId) {
-      throwError(ERRORS.INVALID_PARAMS, 'envId is not defined');
+      throwError(ERRORS.INVALID_PARAMS, 'envId is not defined')
     }
-    this._cache = cache;
-    this._oauthInstance = oauthInstance
+    this.cache = cache
+    this.oauthInstance = oauthInstance
 
     this.user = new User({
-      cache: this._cache,
-      oauthInstance
-    });
+      cache: this.cache,
+      oauthInstance,
+    })
   }
 
   public checkLocalState() {
-    this.oauthLoginState = this._oauthInstance?.authApi.hasLoginStateSync()
-    this.user.checkLocalInfo();
+    this.oauthLoginState = this.oauthInstance?.authApi.hasLoginStateSync()
+    this.user.checkLocalInfo()
   }
 
   public async checkLocalStateAsync() {
-    await this._oauthInstance?.authApi.getLoginState()
-    await this.user.checkLocalInfoAsync();
+    await this.oauthInstance?.authApi.getLoginState()
+    await this.user.checkLocalInfoAsync()
   }
 }
 
 class Auth {
-  private readonly _config: ICloudbaseAuthConfig;
-  private readonly _cache: ICloudbaseCache
-  // private readonly _request: ICloudbaseRequest;
+  private readonly config: ICloudbaseAuthConfig;
+  private readonly cache: ICloudbaseCache;
 
-  private _oauthInstance: CloudbaseOAuth
+  private oauthInstance: CloudbaseOAuth;
 
-  constructor(config: ICloudbaseAuthConfig & { cache: ICloudbaseCache, request?: ICloudbaseRequest, runtime?: string }) {
-    this._config = config;
-    this._cache = config.cache;
-    // this._request = config.request;
-    this._oauthInstance = config.oauthInstance
+  constructor(config: ICloudbaseAuthConfig
+  & { cache: ICloudbaseCache, request?: ICloudbaseRequest, runtime?: string }) {
+    this.config = config
+    this.cache = config.cache
+    this.oauthInstance = config.oauthInstance
   }
 
   /**
@@ -296,11 +295,11 @@ class Auth {
       '请确认以下各项：',
       '  1 - 调用 auth().bindPhoneNumber() 的语法或参数是否正确',
       '  2 - 当前环境是否开通了短信验证码登录',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async bindPhoneNumber(params: authModels.BindPhoneRequest) {
-    return this._oauthInstance.authApi.bindPhone(params)
+    return this.oauthInstance.authApi.bindPhone(params)
   }
 
   /**
@@ -313,11 +312,11 @@ class Auth {
       '请确认以下各项：',
       '  1 - 调用 auth().unbindProvider() 的语法或参数是否正确',
       '  2 - 当前账户是否已经与此登录方式解绑',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async unbindProvider(params: authModels.UnbindProviderRequest): Promise<void> {
-    return this._oauthInstance.authApi.unbindProvider(params)
+    return this.oauthInstance.authApi.unbindProvider(params)
   }
 
   /**
@@ -332,11 +331,11 @@ class Auth {
       '请确认以下各项：',
       '  1 - 调用 auth().bindEmail() 的语法或参数是否正确',
       '  2 - 当前环境是否开通了邮箱密码登录',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public bindEmail(params: authModels.BindEmailRequest) {
-    return this._oauthInstance.authApi.bindEmail(params)
+    return this.oauthInstance.authApi.bindEmail(params)
   }
 
   /**
@@ -351,11 +350,11 @@ class Auth {
       '请确认以下各项：',
       '  1 - 调用 auth().verify() 的语法或参数是否正确',
       '  2 - 当前环境是否开通了手机验证码/邮箱登录',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async verify(params: authModels.VerifyRequest): Promise<authModels.VerifyResponse> {
-    return this._oauthInstance.authApi.verify(params)
+    return this.oauthInstance.authApi.verify(params)
   }
 
   /**
@@ -370,32 +369,32 @@ class Auth {
       '请确认以下各项：',
       '  1 - 调用 auth().getVerification() 的语法或参数是否正确',
       '  2 - 当前环境是否开通了手机验证码/邮箱登录',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
-  public async getVerification(
-    params: authModels.GetVerificationRequest,
-  ): Promise<authModels.GetVerificationResponse> {
-    return this._oauthInstance.authApi.getVerification(params)
+  public async getVerification(params: authModels.GetVerificationRequest): Promise<authModels.GetVerificationResponse> {
+    return this.oauthInstance.authApi.getVerification(params)
   }
 
   /**
    * 获取当前登录的用户信息-同步
    */
   get currentUser() {
-    if (this._cache.mode === 'async') {
+    if (this.cache.mode === 'async') {
       // async storage的平台调用此API提示
-      printWarn(ERRORS.INVALID_OPERATION, 'current platform\'s storage is asynchronous, please use getCurrentUser insteed');
-      return;
+      printWarn(
+        ERRORS.INVALID_OPERATION,
+        'current platform\'s storage is asynchronous, please use getCurrentUser insteed'
+      )
+      return
     }
 
-    const loginState = this.hasLoginState();
+    const loginState = this.hasLoginState()
 
     if (loginState) {
-      return loginState.user || null;
-    } else {
-      return null;
+      return loginState.user || null
     }
+    return null
   }
 
   /**
@@ -406,17 +405,16 @@ class Auth {
     messages: [
       '请确认以下各项：',
       '  1 - 调用 auth().getCurrenUser() 的语法或参数是否正确',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async getCurrentUser() {
-    const loginState = await this.getLoginState();
+    const loginState = await this.getLoginState()
     if (loginState) {
-      await loginState.user.checkLocalInfoAsync();
-      return loginState.user || null;
-    } else {
-      return null;
+      await loginState.user.checkLocalInfoAsync()
+      return loginState.user || null
     }
+    return null
   }
 
 
@@ -431,11 +429,11 @@ class Auth {
       '请确认以下各项：',
       '  1 - 当前环境是否开启了匿名登录',
       '  2 - 调用 auth().signInAnonymously() 的语法或参数是否正确',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async signInAnonymously(): Promise<LoginState> {
-    await this._oauthInstance.authApi.signInAnonymously()
+    await this.oauthInstance.authApi.signInAnonymously()
     return this.createLoginState()
   }
 
@@ -445,7 +443,7 @@ class Auth {
    * @memberof Auth
    */
   public setCustomSignFunc(getTickFn: authModels.GetCustomSignTicketFn): void {
-    this._oauthInstance.authApi.setCustomSignFunc(getTickFn)
+    this.oauthInstance.authApi.setCustomSignFunc(getTickFn)
   }
 
   /**
@@ -461,11 +459,11 @@ class Auth {
       '  2 - 调用 auth().signInWithCustomTicket() 的语法或参数是否正确',
       '  3 - ticket 是否归属于当前环境',
       '  4 - 创建 ticket 的自定义登录私钥是否过期',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async signInWithCustomTicket(): Promise<LoginState> {
-    await this._oauthInstance.authApi.signInWithCustomTicket()
+    await this.oauthInstance.authApi.signInWithCustomTicket()
     return this.createLoginState()
   }
 
@@ -476,7 +474,7 @@ class Auth {
    * @memberof Auth
    */
   public async signIn(params: authModels.SignInRequest): Promise<LoginState> {
-    await this._oauthInstance.authApi.signIn(params)
+    await this.oauthInstance.authApi.signIn(params)
     return this.createLoginState()
   }
 
@@ -492,11 +490,11 @@ class Auth {
       '请确认以下各项：',
       '  1 - 当前环境是否开启了指定登录方式',
       '  2 - 调用 auth().signUp() 的语法或参数是否正确',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async signUp(params: authModels.SignUpRequest): Promise<LoginState> {
-    await this._oauthInstance.authApi.signUp(params)
+    await this.oauthInstance.authApi.signUp(params)
     return this.createLoginState()
   }
 
@@ -507,7 +505,7 @@ class Auth {
    * @memberof Auth
    */
   public async setPassword(params: authModels.SetPasswordRequest): Promise<void> {
-    return this._oauthInstance.authApi.setPassword(params)
+    return this.oauthInstance.authApi.setPassword(params)
   }
 
   /**
@@ -519,15 +517,15 @@ class Auth {
     messages: [
       '请确认以下各项：',
       '  1 - 调用 auth().isUsernameRegistered() 的语法或参数是否正确',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async isUsernameRegistered(username: string): Promise<boolean> {
     if (typeof username !== 'string') {
-      throwError(ERRORS.INVALID_PARAMS, 'username must be a string');
+      throwError(ERRORS.INVALID_PARAMS, 'username must be a string')
     }
 
-    const { exist } = await this._oauthInstance.authApi.checkIfUserExist({ username })
+    const { exist } = await this.oauthInstance.authApi.checkIfUserExist({ username })
     return exist
   }
 
@@ -540,13 +538,13 @@ class Auth {
       '请确认以下各项：',
       '  1 - 调用 auth().signOut() 的语法或参数是否正确',
       '  2 - 当前用户是否为匿名登录（匿名登录不支持signOut）',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async signOut() {
-    const { userInfoKey } = this._cache.keys;
-    await this._oauthInstance.authApi.signOut()
-    await this._cache.removeStoreAsync(userInfoKey)
+    const { userInfoKey } = this.cache.keys
+    await this.oauthInstance.authApi.signOut()
+    await this.cache.removeStoreAsync(userInfoKey)
     eventBus.fire(EVENTS.LOGIN_STATE_CHANGED)
   }
 
@@ -554,23 +552,25 @@ class Auth {
    * 获取本地登录态-同步
    */
   public hasLoginState(): LoginState | null {
-    if (this._cache.mode === 'async') {
+    if (this.cache.mode === 'async') {
       // async storage的平台调用此API提示
-      printWarn(ERRORS.INVALID_OPERATION, 'current platform\'s storage is asynchronous, please use getLoginState insteed');
-      return;
+      printWarn(
+        ERRORS.INVALID_OPERATION,
+        'current platform\'s storage is asynchronous, please use getLoginState insteed'
+      )
+      return
     }
 
-    const oauthLoginState = this._oauthInstance?.authApi.hasLoginStateSync()
+    const oauthLoginState = this.oauthInstance?.authApi.hasLoginStateSync()
     if (oauthLoginState) {
       const loginState = new LoginState({
-        envId: this._config.env,
-        cache: this._cache,
-        oauthInstance: this._oauthInstance,
+        envId: this.config.env,
+        cache: this.cache,
+        oauthInstance: this.oauthInstance,
       })
       return loginState
-    } else {
-      return null
     }
+    return null
   }
 
   /**
@@ -582,16 +582,16 @@ class Auth {
     messages: [
       '请确认以下各项：',
       '  1 - 调用 auth().getLoginState() 的语法或参数是否正确',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async getLoginState() {
-    const oauthLoginState = await this._oauthInstance.authApi.getLoginState()
+    const oauthLoginState = await this.oauthInstance.authApi.getLoginState()
     if (oauthLoginState) {
       const loginState = new LoginState({
-        envId: this._config.env,
-        cache: this._cache,
-        oauthInstance: this._oauthInstance,
+        envId: this.config.env,
+        cache: this.cache,
+        oauthInstance: this.oauthInstance,
       })
       return loginState
     }
@@ -605,13 +605,13 @@ class Auth {
       '请确认以下各项：',
       '  1 - 是否已登录',
       '  2 - 调用 auth().getUserInfo() 的语法或参数是否正确',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
   public async getUserInfo(): Promise<IUserInfo> {
-    return this._oauthInstance.authApi.getUserInfo()
+    return this.oauthInstance.authApi.getUserInfo()
   }
-  
+
   /**
    * getAuthHeader 兼容处理
    * 返回空对象
@@ -620,7 +620,7 @@ class Auth {
     console.error('Auth.getAuthHeader API 已废弃')
     return {}
   }
-  
+
   /**
    * 为已有账户绑第三方账户
    * @param {authModels.BindWithProviderRequest} params
@@ -633,13 +633,11 @@ class Auth {
       '请确认以下各项：',
       '  1 - 调用 auth().bindWithProvider() 的语法或参数是否正确',
       '  2 - 此账户是否已经绑定此第三方',
-      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`
-    ]
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
   })
-  public async bindWithProvider(
-    params: authModels.BindWithProviderRequest,
-  ): Promise<void> {
-    return this._oauthInstance.authApi.bindWithProvider(params)
+  public async bindWithProvider(params: authModels.BindWithProviderRequest,): Promise<void> {
+    return this.oauthInstance.authApi.bindWithProvider(params)
   }
 
   /**
@@ -648,92 +646,84 @@ class Auth {
    * @returns {Promise<authModels.UserProfile>}
    * @memberof Auth
    */
-  public async queryUser(
-    queryObj: authModels.QueryUserProfileRequest,
-  ): Promise<authModels.QueryUserProfileResponse> {
-    return this._oauthInstance.authApi.queryUserProfile(queryObj)
+  public async queryUser(queryObj: authModels.QueryUserProfileRequest): Promise<authModels.QueryUserProfileResponse> {
+    return this.oauthInstance.authApi.queryUserProfile(queryObj)
   }
 
   public async getAccessToken() {
-    const oauthAccessTokenRes = await this._oauthInstance.oauth2client.getAccessToken()
+    const oauthAccessTokenRes = await this.oauthInstance.oauth2client.getAccessToken()
     return {
       accessToken: oauthAccessTokenRes,
-      env: this._config.env
-    };
+      env: this.config.env,
+    }
   }
 
-  public async grantProviderToken(
-    params: authModels.GrantProviderTokenRequest,
-  ): Promise<authModels.GrantProviderTokenResponse> {
-    return this._oauthInstance.authApi.grantProviderToken(params)
+  public async grantProviderToken(params: authModels.GrantProviderTokenRequest): Promise<authModels.GrantProviderTokenResponse> {
+    return this.oauthInstance.authApi.grantProviderToken(params)
   }
 
-  public async signInWithProvider(
-    params: authModels.SignInWithProviderRequest,
-  ): Promise<LoginState> {
-    await this._oauthInstance.authApi.signInWithProvider(params)
+  public async signInWithProvider(params: authModels.SignInWithProviderRequest): Promise<LoginState> {
+    await this.oauthInstance.authApi.signInWithProvider(params)
     return this.createLoginState()
   }
 
   public async grantToken(params: authModels.GrantTokenRequest): Promise<LoginState> {
-    await this._oauthInstance.authApi.grantToken(params)
+    await this.oauthInstance.authApi.grantToken(params)
     return this.createLoginState()
   }
 
-  public async genProviderRedirectUri(
-    params: authModels.GenProviderRedirectUriRequest,
-  ): Promise<authModels.GenProviderRedirectUriResponse> {
-    return this._oauthInstance.authApi.genProviderRedirectUri(params)
+  public async genProviderRedirectUri(params: authModels.GenProviderRedirectUriRequest): Promise<authModels.GenProviderRedirectUriResponse> {
+    return this.oauthInstance.authApi.genProviderRedirectUri(params)
   }
 
   public async resetPassword(params: authModels.ResetPasswordRequest): Promise<void> {
-    return this._oauthInstance.authApi.resetPassword(params)
+    return this.oauthInstance.authApi.resetPassword(params)
   }
 
   public async deviceAuthorize(params: authModels.DeviceAuthorizeRequest): Promise<authModels.DeviceAuthorizeResponse> {
-    return this._oauthInstance.authApi.deviceAuthorize(params)
+    return this.oauthInstance.authApi.deviceAuthorize(params)
   }
 
   public async sudo(params: authModels.SudoRequest): Promise<authModels.SudoResponse> {
-    return this._oauthInstance.authApi.sudo(params)
+    return this.oauthInstance.authApi.sudo(params)
   }
 
   public async deleteMe(params: authModels.WithSudoRequest): Promise<authModels.UserProfile> {
-    return this._oauthInstance.authApi.deleteMe(params)
+    return this.oauthInstance.authApi.deleteMe(params)
   }
 
   public async getProviders(): Promise<authModels.UserProfileProvider> {
-    return this._oauthInstance.authApi.getProviders()
+    return this.oauthInstance.authApi.getProviders()
   }
 
   public async loginScope(): Promise<string> {
-    return this._oauthInstance.authApi.loginScope()
+    return this.oauthInstance.authApi.loginScope()
   }
 
   public async loginGroups(): Promise<string[]> {
-    return this._oauthInstance.authApi.loginGroups()
+    return this.oauthInstance.authApi.loginGroups()
   }
 
   public async onLoginStateChanged(callback: Function) {
     eventBus.on(EVENTS.LOGIN_STATE_CHANGED, async () => {
-      const loginState = await this.getLoginState();
-      callback.call(this, loginState);
-    });
+      const loginState = await this.getLoginState()
+      callback.call(this, loginState)
+    })
     // 立刻执行一次回调
-    const loginState = await this.getLoginState();
-    callback.call(this, loginState);
+    const loginState = await this.getLoginState()
+    callback.call(this, loginState)
   }
 
   private async createLoginState(): Promise<LoginState> {
     const loginState = new LoginState({
-      envId: this._config.env,
-      cache: this._cache,
-      oauthInstance: this._oauthInstance,
+      envId: this.config.env,
+      cache: this.cache,
+      oauthInstance: this.oauthInstance,
     })
 
-    await loginState.checkLocalStateAsync();
-    await loginState.user.refresh();
-    eventBus.fire(EVENTS.LOGIN_STATE_CHANGED);
+    await loginState.checkLocalStateAsync()
+    await loginState.user.refresh()
+    eventBus.fire(EVENTS.LOGIN_STATE_CHANGED)
     return loginState
   }
 }
@@ -741,21 +731,22 @@ class Auth {
 const component: ICloudbaseComponent = {
   name: COMPONENT_NAME,
   namespace: 'auth',
-  entity: function (config: Pick<ICloudbaseAuthConfig, 'region' | 'persistence'> = { region: '', persistence: 'local' }) {
+  entity(config: Pick<ICloudbaseAuthConfig, 'region' | 'persistence'>
+  = { region: '', persistence: 'local' }) {
     if (this.authInstance) {
-      printWarn(ERRORS.INVALID_OPERATION, 'every cloudbase instance should has only one auth object');
-      return this.authInstance;
+      printWarn(ERRORS.INVALID_OPERATION, 'every cloudbase instance should has only one auth object')
+      return this.authInstance
     }
-    const { adapter, runtime } = this.platform;
+    const { adapter, runtime } = this.platform
     // 如不明确指定persistence则优先取各平台adapter首选，其次localStorage
-    const newPersistence = config.persistence || adapter.primaryStorage;
+    const newPersistence = config.persistence || adapter.primaryStorage
     if (newPersistence && (newPersistence !== this.config.persistence)) {
       this.updateConfig({ persistence: newPersistence })
     }
 
-    const { env, persistence, debug, clientId } = this.config;
+    const { env, persistence, debug, clientId } = this.config
     const oauthInstance = new CloudbaseOAuth({
-      clientId: clientId,
+      clientId,
       apiOrigin: this.request.getBaseEndPoint(),
     })
 
@@ -768,34 +759,34 @@ const component: ICloudbaseComponent = {
       debug,
       cache: this.cache,
       // request: this.request,
-      runtime: runtime,
+      runtime,
       _fromApp: this,
       // oauthInstance: this.oauthInstance || (this as any).oauth()
-      oauthInstance
-    });
+      oauthInstance,
+    })
 
-    return this.authInstance;
-  }
+    return this.authInstance
+  },
 }
 
 try {
   // 尝试自动注册至全局变量cloudbase
   // 此行为只在浏览器环境下有效
-  cloudbase.registerComponent(component);
+  cloudbase.registerComponent(component)
 } catch (e) { }
 
 export {
   UserInfo,
   Auth,
-};
+}
 /**
  * @api 手动注册至cloudbase app
  */
 export function registerAuth(app: Pick<ICloudbase, 'registerComponent'>) {
   try {
-    app.registerComponent(component);
+    app.registerComponent(component)
   } catch (e) {
-    console.warn(e);
+    console.warn(e)
   }
 }