@cloudbase/js-sdk 2.24.4 → 2.24.5

package/index.d.ts

@@ -1,6 +1,34 @@
 import { OrmClient, OrmRawQueryClient } from '@cloudbase/model';
 import { IMySqlClient } from '@cloudbase/mysql';
 import { authModels } from '@cloudbase/oauth';
+import type {
+  SignInRes,
+  GetUserRes,
+  CommonRes,
+  SignInWithOtpRes,
+  SignInOAuthRes,
+  GetClaimsRes,
+  ResetPasswordForEmailRes,
+  GetUserIdentitiesRes,
+  LinkIdentityRes,
+  ReauthenticateRes,
+  ResendRes,
+  UpdateUserWithVerificationRes,
+  OnAuthStateChangeCallback,
+  SignInWithPasswordReq,
+  SignInWithIdTokenReq,
+  SignInWithOAuthReq,
+  VerifyOAuthReq,
+  VerifyOtpReq,
+  LinkIdentityReq,
+  UnlinkIdentityReq,
+  UpdateUserReq,
+  SignInWithOtpReq,
+  ResetPasswordForOldReq,
+  ResendReq,
+  SetSessionReq,
+  DeleteMeReq,
+} from '@cloudbase/auth';
 import { AI } from '@cloudbase/ai';
 import { CloudbaseAdapter, ResponseObject } from '@cloudbase/adapter-interface'
 import { ICloudbaseUpgradedConfig, ICloudbase, Persistence } from '@cloudbase/types'
@@ -260,7 +288,7 @@ declare namespace cloudbase.app {
      *
      * @return {!cloudbase.auth.App} Auth实例
      */
-    auth(options?: { persistence: cloudbase.auth.Persistence }): cloudbase.auth.App
+    auth: ((options?: { persistence: cloudbase.auth.Persistence }) => cloudbase.auth.App) & cloudbase.auth.App
     /**
      * 调用云函数
      *
@@ -758,8 +786,9 @@ declare namespace cloudbase.auth {
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetverification}
      *
      * @param params
+     * @param options
      */
-    getVerification(params: authModels.GetVerificationRequest): Promise<authModels.GetVerificationResponse>
+    getVerification(params: authModels.GetVerificationRequest, options?: { withCaptcha: boolean }): Promise<authModels.GetVerificationResponse>
     /**
      * 匿名登录
      *
@@ -768,6 +797,54 @@ declare namespace cloudbase.auth {
      *
      */
     signInAnonymously(data?: { provider_token?: string }): Promise<ILoginState>
+    /**
+     * 小程序匿名登录
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninanonymouslyinwx}
+     *
+     * @param params
+     */
+    signInAnonymouslyInWx(params?: { useWxCloud?: boolean }): Promise<ILoginState>
+    /**
+     * 小程序绑定OpenID
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authbindopenid}
+     *
+     */
+    bindOpenId(): Promise<void>
+    /**
+     * 小程序unionId静默登录
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithunionid}
+     *
+     */
+    signInWithUnionId(): Promise<ILoginState>
+    /**
+     * 短信验证码登录
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithsms}
+     *
+     * @param params
+     */
+    signInWithSms(params: {
+      verificationInfo?: { verification_id: string; is_user: boolean }
+      verificationCode?: string
+      phoneNum?: string
+      bindInfo?: any
+    }): Promise<ILoginState>
+    /**
+     * 邮箱验证码登录
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithemail}
+     *
+     * @param params
+     */
+    signInWithEmail(params: {
+      verificationInfo?: { verification_id: string; is_user: boolean }
+      verificationCode?: string
+      email?: string
+      bindInfo?: any
+    }): Promise<ILoginState>
     /**
      * 设置获取自定义登录 ticket 的函数
      *
@@ -781,8 +858,10 @@ declare namespace cloudbase.auth {
      * 使用自定义登录 ticket 登录
      *
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithcustomticket}
+     *
+     * @param getTickFn
      */
-    signInWithCustomTicket(): Promise<ILoginState>
+    signInWithCustomTicket(getTickFn?: authModels.GetCustomSignTicketFn): Promise<ILoginState>
     /**
      * 用户登录，目前支持手机号，邮箱，用户名密码登录
      *
@@ -808,6 +887,20 @@ declare namespace cloudbase.auth {
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetuserinfo}
      */
     getUserInfo(): Promise<IUserInfo>
+    /**
+     * 获取微搭插件用户信息
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetwedauserinfo}
+     */
+    getWedaUserInfo(): Promise<any>
+    /**
+     * 更新用户基本信息
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authupdateuserbasicinfo}
+     *
+     * @param params
+     */
+    updateUserBasicInfo(params: authModels.ModifyUserBasicInfoRequest): Promise<void>
     /**
      * 获取本地登录态-同步操作
      *
@@ -878,6 +971,12 @@ declare namespace cloudbase.auth {
      * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithprovider}
      */
     signInWithProvider(params: authModels.SignInWithProviderRequest): Promise<ILoginState>
+    /**
+     * 微信登录
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithwechat}
+     */
+    signInWithWechat(params?: any): Promise<ILoginState>
     grantToken(params: authModels.GrantTokenRequest): Promise<ILoginState>
     /**
      * 生成第三方平台授权 Uri （如微信二维码扫码授权网页）
@@ -920,7 +1019,75 @@ declare namespace cloudbase.auth {
     loginScope(): Promise<string>
     loginGroups(): Promise<string[]>
     onLoginStateChanged(callback: Function)
-    createLoginState(): Promise<ILoginState>
+    createLoginState(params?: { version?: string; query?: any }, options?: { asyncRefreshUser?: boolean; userInfo?: any }): Promise<ILoginState>
+    /**
+     * 强制刷新token
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authrefreshtokenforce}
+     *
+     * @param params
+     */
+    refreshTokenForce(params: { version?: string }): Promise<authModels.Credentials>
+    /**
+     * 获取身份信息
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetcredentials}
+     */
+    getCredentials(): Promise<authModels.Credentials>
+    /**
+     * 写入身份信息
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsetcredentials}
+     *
+     * @param credentials
+     */
+    setCredentials(credentials: authModels.Credentials): Promise<void>
+    /**
+     * 获取身份源类型
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetprovidersubtype}
+     */
+    getProviderSubType(): Promise<authModels.ProviderSubType>
+    /**
+     * 创建验证码数据
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authcreatecaptchadata}
+     *
+     * @param params
+     */
+    createCaptchaData(params: { state: string; redirect_uri?: string }): Promise<any>
+    /**
+     * 验证验证码数据
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authverifycaptchadata}
+     *
+     * @param params
+     */
+    verifyCaptchaData(params: { token: string; key: string }): Promise<any>
+    /**
+     * 修改密码
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authmodifypassword}
+     *
+     * @param params
+     */
+    modifyPassword(params: authModels.ModifyUserBasicInfoRequest): Promise<void>
+    /**
+     * 未登录状态修改密码
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authmodifypasswordwithoutlogin}
+     *
+     * @param params
+     */
+    modifyPasswordWithoutLogin(params: authModels.ModifyPasswordWithoutLoginRequest): Promise<void>
+    /**
+     * 获取用户行为日志
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetuserbehaviorlog}
+     *
+     * @param params
+     */
+    getUserBehaviorLog(params: authModels.GetUserBehaviorLog): Promise<authModels.GetUserBehaviorLogRes>
     /**
      * 退出登录，请注意，匿名登录不支持退出
      *
@@ -963,7 +1130,188 @@ declare namespace cloudbase.auth {
     getMiniProgramQrCodeStatus(
       params: authModels.GetMiniProgramQrCodeStatusRequest,
     ): Promise<authModels.GetMiniProgramQrCodeStatusResponse>
-    toDefaultLoginPage(params: authModels.ToDefaultLoginPage): Promise<void>
+    toDefaultLoginPage(params?: authModels.ToDefaultLoginPage): Promise<void>
+    /**
+     * 监听认证状态变化
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authonauthstatechange}
+     *
+     * @param callback
+     */
+    onAuthStateChange(callback: OnAuthStateChangeCallback): { data: { subscription: { id: string; callback: Function; unsubscribe: () => void } } }
+    /**
+     * 使用用户名和密码登录
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithpassword}
+     *
+     * @param params
+     */
+    signInWithPassword(params: SignInWithPasswordReq): Promise<SignInRes>
+    /**
+     * 使用第三方平台 ID Token 登录
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithidtoken}
+     *
+     * @param params
+     */
+    signInWithIdToken(params: SignInWithIdTokenReq): Promise<SignInRes>
+    /**
+     * 使用一次性密码（OTP）登录
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithotp}
+     *
+     * @param params
+     */
+    signInWithOtp(params: SignInWithOtpReq): Promise<SignInWithOtpRes>
+    /**
+     * 校验第三方平台授权登录回调
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authverifyoauth}
+     *
+     * @param params
+     */
+    verifyOAuth(params?: VerifyOAuthReq): Promise<SignInRes>
+    /**
+     * 生成第三方平台授权 Uri
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithoauth}
+     *
+     * @param params
+     */
+    signInWithOAuth(params: SignInWithOAuthReq): Promise<SignInOAuthRes>
+    /**
+     * 获取用户声明信息
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetclaims}
+     */
+    getClaims(): Promise<GetClaimsRes>
+    /**
+     * 通过邮箱或手机号重置密码
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authresetpasswordforemail}
+     *
+     * @param emailOrPhone
+     * @param options
+     */
+    resetPasswordForEmail(emailOrPhone: string, options?: { redirectTo?: string }): Promise<ResetPasswordForEmailRes>
+    /**
+     * 通过旧密码重置密码
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authresetpasswordforold}
+     *
+     * @param params
+     */
+    resetPasswordForOld(params: ResetPasswordForOldReq): Promise<SignInRes>
+    /**
+     * 验证一次性密码（OTP）
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authverifyotp}
+     *
+     * @param params
+     */
+    verifyOtp(params: VerifyOtpReq): Promise<SignInRes>
+    /**
+     * 获取当前会话
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetsession}
+     */
+    getSession(): Promise<SignInRes>
+    /**
+     * 刷新会话
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authrefreshsession}
+     *
+     * @param refresh_token
+     */
+    refreshSession(refresh_token?: string): Promise<SignInRes>
+    /**
+     * 获取当前用户详细信息
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetuser}
+     */
+    getUser(): Promise<GetUserRes>
+    /**
+     * 刷新用户信息
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authrefreshuser}
+     */
+    refreshUser(): Promise<CommonRes>
+    /**
+     * 更新用户信息
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authupdateuser}
+     *
+     * @param params
+     */
+    updateUser(params: UpdateUserReq): Promise<GetUserRes | UpdateUserWithVerificationRes>
+    /**
+     * 获取所有身份源
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authgetuseridentities}
+     */
+    getUserIdentities(): Promise<GetUserIdentitiesRes>
+    /**
+     * 绑定身份源到当前用户
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authlinkidentity}
+     *
+     * @param params
+     */
+    linkIdentity(params: LinkIdentityReq): Promise<LinkIdentityRes>
+    /**
+     * 解绑身份源
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authunlinkidentity}
+     *
+     * @param params
+     */
+    unlinkIdentity(params: UnlinkIdentityReq): Promise<CommonRes>
+    /**
+     * 重新认证
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authreauthenticate}
+     */
+    reauthenticate(): Promise<ReauthenticateRes>
+    /**
+     * 重新发送验证码
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authresend}
+     *
+     * @param params
+     */
+    resend(params: ResendReq): Promise<ResendRes>
+    /**
+     * 使用 access_token 和 refresh_token 设置会话
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsetsession}
+     *
+     * @param params
+     */
+    setSession(params: SetSessionReq): Promise<SignInRes>
+    /**
+     * 删除当前用户
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authdeleteuser}
+     *
+     * @param params
+     */
+    deleteUser(params: DeleteMeReq): Promise<CommonRes>
+    /**
+     * 小程序 openId 静默登录
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithopenid}
+     *
+     * @param params
+     */
+    signInWithOpenId(params?: { useWxCloud?: boolean }): Promise<SignInRes>
+    /**
+     * 小程序手机号授权登录
+     *
+     * 文档 {@link https://docs.cloudbase.net/api-reference/webv3/authentication#authsigninwithphoneauth}
+     *
+     * @param params
+     */
+    signInWithPhoneAuth(params: { phoneCode: string }): Promise<SignInRes>
   }
 }
 /**