@cloudbase/auth 2.26.0 → 2.26.2

package/dist/esm/index.d.ts

@@ -4,7 +4,8 @@ import type { ICloudbaseRequest } from '@cloudbase/types/request';
 import type { ICloudbaseAuthConfig, IUser, ILoginState } from '@cloudbase/types/auth';
 import type { AuthOptions, Credentials } from '@cloudbase/oauth';
 import { CloudbaseOAuth, AuthError, authModels } from '@cloudbase/oauth';
-import { CommonRes, DeleteMeReq, GetClaimsRes, GetUserIdentitiesRes, GetUserRes, LinkIdentityReq, LinkIdentityRes, OnAuthStateChangeCallback, ReauthenticateRes, ResendReq, ResendRes, ResetPasswordForEmailRes, ResetPasswordForOldReq, SetSessionReq, SignInAnonymouslyReq, SignInOAuthRes, SignInRes, SignInWithIdTokenReq, SignInWithOAuthReq, SignInWithOtpReq, SignInWithOtpRes, SignInWithPasswordReq, SignUpRes, UnlinkIdentityReq, UpdateUserReq, UpdateUserWithVerificationRes, VerifyOAuthReq, VerifyOtpReq } from './type';
+import { AuthV1Compat, WeixinAuthProvider, CustomAuthProvider, AnonymousAuthProvider } from './v1-compat';
+import { CommonRes, DeleteMeReq, GetClaimsRes, GetUserIdentitiesRes, GetUserRes, LinkIdentityReq, LinkIdentityRes, OnAuthStateChangeCallback, ReauthenticateRes, ResendReq, ResendRes, ResetPasswordForEmailRes, ResetPasswordForOldReq, SetSessionReq, SignInAnonymouslyReq, SignInOAuthRes, SignInRes, SignInWithIdTokenReq, SignInWithOAuthReq, SignInWithOtpReq, SignInWithOtpRes, SignInWithPasswordReq, SignUpRes, UnlinkIdentityReq, UpdateUserReq, UpdateUserWithVerificationRes, VerifyOAuthReq, VerifyOAuthRes, VerifyOtpReq } from './type';
 export 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, SignUpRes, } from './type';
 interface UserInfo {
     uid?: string;
@@ -74,17 +75,79 @@ export declare class LoginState implements ILoginState {
     checkLocalState(): void;
     checkLocalStateAsync(): Promise<void>;
 }
-declare class Auth {
-    readonly config: ICloudbaseAuthConfig;
+interface IAuthConfig extends ICloudbaseAuthConfig {
+    cache: ICloudbaseCache;
+    request?: ICloudbaseRequest;
+    runtime?: string;
+}
+declare class Auth extends AuthV1Compat {
+    readonly config: IAuthConfig;
     oauthInstance: CloudbaseOAuth;
     readonly cache: ICloudbaseCache;
     private listeners;
     private hasListenerSetUp;
-    constructor(config: ICloudbaseAuthConfig & {
-        cache: ICloudbaseCache;
-        request?: ICloudbaseRequest;
-        runtime?: string;
-    });
+    constructor(config: IAuthConfig);
+    signInAnonymously(params: SignInAnonymouslyReq): Promise<SignInRes>;
+    signUp(params: authModels.SignUpRequest & {
+        phone?: string;
+    }): Promise<SignUpRes>;
+    signOut(params?: authModels.SignoutRequest): Promise<authModels.SignoutResponse & {
+        data: Object;
+        error: AuthError;
+    }>;
+    onAuthStateChange(callback: OnAuthStateChangeCallback): {
+        data: {
+            subscription: {
+                id: string;
+                callback: OnAuthStateChangeCallback;
+                unsubscribe: () => void;
+            };
+        };
+    };
+    signInWithPassword(params: SignInWithPasswordReq): Promise<SignInRes>;
+    signInWithIdToken(params: SignInWithIdTokenReq): Promise<SignInRes>;
+    signInWithOtp(params: SignInWithOtpReq): Promise<SignInWithOtpRes>;
+    verifyOAuth(params?: VerifyOAuthReq): Promise<VerifyOAuthRes>;
+    signInWithOAuth(params: SignInWithOAuthReq): Promise<SignInOAuthRes>;
+    getClaims(): Promise<GetClaimsRes>;
+    resetPasswordForEmail(emailOrPhone: string, options?: {
+        redirectTo?: string;
+    }): Promise<ResetPasswordForEmailRes>;
+    resetPasswordForOld(params: ResetPasswordForOldReq): Promise<{
+        data: {
+            user: import("./type").User;
+            session: import("./type").Session;
+        };
+        error: any;
+    } | {
+        data: {
+            user?: undefined;
+            session?: undefined;
+        };
+        error: AuthError;
+    }>;
+    verifyOtp(params: VerifyOtpReq): Promise<SignInRes>;
+    getSession(): Promise<SignInRes>;
+    refreshSession(refresh_token?: string): Promise<SignInRes>;
+    getUser(): Promise<GetUserRes>;
+    refreshUser(): Promise<CommonRes>;
+    updateUser(params: UpdateUserReq): Promise<GetUserRes | UpdateUserWithVerificationRes>;
+    getUserIdentities(): Promise<GetUserIdentitiesRes>;
+    linkIdentity(params: LinkIdentityReq): Promise<LinkIdentityRes>;
+    unlinkIdentity(params: UnlinkIdentityReq): Promise<CommonRes>;
+    reauthenticate(): Promise<ReauthenticateRes>;
+    resend(params: ResendReq): Promise<ResendRes>;
+    setSession(params: SetSessionReq): Promise<SignInRes>;
+    exchangeCodeForSession(): Promise<void>;
+    deleteUser(params: DeleteMeReq): Promise<CommonRes>;
+    toDefaultLoginPage(params?: authModels.ToDefaultLoginPage): Promise<CommonRes>;
+    signInWithCustomTicket(getTickFn?: authModels.GetCustomSignTicketFn): Promise<SignInRes>;
+    signInWithOpenId({ useWxCloud }?: {
+        useWxCloud?: boolean;
+    }): Promise<SignInRes>;
+    signInWithPhoneAuth({ phoneCode }: {
+        phoneCode?: string;
+    }): Promise<SignInRes>;
     bindPhoneNumber(params: authModels.BindPhoneRequest): Promise<void>;
     unbindProvider(params: authModels.UnbindProviderRequest): Promise<void>;
     bindEmail(params: authModels.BindEmailRequest): Promise<void>;
@@ -187,68 +250,7 @@ declare class Auth {
         userInfo?: any;
     }): Promise<LoginState>;
     setAccessKey(): Promise<void>;
-    signInAnonymously(params: SignInAnonymouslyReq): Promise<SignInRes>;
-    signUp(params: authModels.SignUpRequest & {
-        phone?: string;
-    }): Promise<SignUpRes>;
-    signOut(params?: authModels.SignoutRequest): Promise<authModels.SignoutResponse & {
-        data: Object;
-        error: AuthError;
-    }>;
-    onAuthStateChange(callback: OnAuthStateChangeCallback): {
-        data: {
-            subscription: {
-                id: string;
-                callback: OnAuthStateChangeCallback;
-                unsubscribe: () => void;
-            };
-        };
-    };
-    signInWithPassword(params: SignInWithPasswordReq): Promise<SignInRes>;
-    signInWithIdToken(params: SignInWithIdTokenReq): Promise<SignInRes>;
-    signInWithOtp(params: SignInWithOtpReq): Promise<SignInWithOtpRes>;
-    verifyOAuth(params?: VerifyOAuthReq): Promise<SignInRes | LinkIdentityRes>;
-    signInWithOAuth(params: SignInWithOAuthReq): Promise<SignInOAuthRes>;
-    getClaims(): Promise<GetClaimsRes>;
-    resetPasswordForEmail(emailOrPhone: string, options?: {
-        redirectTo?: string;
-    }): Promise<ResetPasswordForEmailRes>;
-    resetPasswordForOld(params: ResetPasswordForOldReq): Promise<{
-        data: {
-            user: import("./type").User;
-            session: import("./type").Session;
-        };
-        error: any;
-    } | {
-        data: {
-            user?: undefined;
-            session?: undefined;
-        };
-        error: AuthError;
-    }>;
-    verifyOtp(params: VerifyOtpReq): Promise<SignInRes>;
-    getSession(): Promise<SignInRes>;
-    refreshSession(refresh_token?: string): Promise<SignInRes>;
-    getUser(): Promise<GetUserRes>;
-    refreshUser(): Promise<CommonRes>;
-    updateUser(params: UpdateUserReq): Promise<GetUserRes | UpdateUserWithVerificationRes>;
-    getUserIdentities(): Promise<GetUserIdentitiesRes>;
-    linkIdentity(params: LinkIdentityReq): Promise<LinkIdentityRes>;
-    unlinkIdentity(params: UnlinkIdentityReq): Promise<CommonRes>;
-    reauthenticate(): Promise<ReauthenticateRes>;
-    resend(params: ResendReq): Promise<ResendRes>;
-    setSession(params: SetSessionReq): Promise<SignInRes>;
-    exchangeCodeForSession(): Promise<void>;
-    deleteUser(params: DeleteMeReq): Promise<CommonRes>;
-    toDefaultLoginPage(params?: authModels.ToDefaultLoginPage): Promise<CommonRes>;
-    signInWithCustomTicket(getTickFn?: authModels.GetCustomSignTicketFn): Promise<SignInRes>;
-    signInWithOpenId({ useWxCloud }?: {
-        useWxCloud?: boolean;
-    }): Promise<SignInRes>;
-    signInWithPhoneAuth({ phoneCode }: {
-        phoneCode?: string;
-    }): Promise<SignInRes>;
-    private formatPhone;
+    protected formatPhone(phone: string): string;
     private notifyListeners;
     private setupListeners;
     private convertToUser;
@@ -256,7 +258,7 @@ declare class Auth {
     private validateAtLeastOne;
     private init;
 }
-type TInitAuthOptions = Pick<ICloudbaseAuthConfig, 'region' | 'persistence' | 'i18n' | 'accessKey' | 'useWxCloud'> & Partial<AuthOptions> & {
+type TInitAuthOptions = Pick<ICloudbaseAuthConfig, 'region' | 'persistence' | 'i18n' | 'accessKey' | 'useWxCloud' | 'auth'> & Partial<AuthOptions> & {
     detectSessionInUrl?: boolean;
 };
 export declare function generateAuthInstance(config: TInitAuthOptions & {
@@ -274,5 +276,5 @@ export declare function generateAuthInstance(config: TInitAuthOptions & {
     authInstance: Auth;
     oauthInstance: CloudbaseOAuth;
 };
-export { UserInfo, Auth };
+export { UserInfo, Auth, WeixinAuthProvider, CustomAuthProvider, AnonymousAuthProvider };
 export declare function registerAuth(app: Pick<ICloudbase, 'registerComponent'>): void;