@cloudbase/oauth 2.25.2 → 2.25.4

package/dist/esm/auth/apis.d.ts

@@ -0,0 +1,141 @@
+import { GetVerificationRequest, GetVerificationResponse, UserProfile, UserInfo, SignInRequest, SignUpRequest, VerifyRequest, VerifyResponse, GenProviderRedirectUriRequest, GenProviderRedirectUriResponse, GrantProviderTokenRequest, GrantProviderTokenResponse, PatchProviderTokenRequest, PatchProviderTokenResponse, SignInWithProviderRequest, SignInCustomRequest, BindWithProviderRequest, TransByProviderRequest, GrantTokenRequest, UnbindProviderRequest, CheckPasswordRequest, SetPasswordRequest, ChangeBoundProviderRequest, ChangeBoundProviderResponse, UpdatePasswordRequest, SudoResponse, SudoRequest, GetCustomSignTicketFn, QueryUserProfileRequest, QueryUserProfileResponse, ResetPasswordRequest, DeviceAuthorizeRequest, DeviceAuthorizeResponse, CheckUsernameRequest, CheckIfUserExistRequest, CheckIfUserExistResponse, WithSudoRequest, PublicKey, EncryptParams, ProviderSubType, GetMiniProgramQrCodeRequest, GetMiniProgramQrCodeStatusRequest, GetMiniProgramQrCodeResponse, GetMiniProgramQrCodeStatusResponse, ModifyUserBasicInfoRequest, EditContactRequest, AuthorizeInfoRequest, AuthorizeInfoResponse, AuthorizeDeviceRequest, AuthorizeRequest, AuthorizeResponse, GetUserBehaviorLog, GetUserBehaviorLogRes, RevokeDeviceRequest, SignoutResponse, ProvidersResponse, SignoutRequest, ModifyPasswordWithoutLoginRequest } from './models';
+import { SimpleStorage, RequestFunction } from '../oauth2client/interface';
+import { OAuth2Client } from '../oauth2client/oauth2client';
+import { Credentials } from '../oauth2client/models';
+import { CaptchaOptions } from '../captcha/captcha';
+import { SDKAdapterInterface } from '@cloudbase/adapter-interface';
+import { ICloudbaseConfig } from '@cloudbase/types';
+export interface AuthOptions {
+    apiOrigin: string;
+    apiPath?: string;
+    clientId: string;
+    clientSecret?: string;
+    credentialsClient?: OAuth2Client;
+    request?: RequestFunction;
+    baseRequest?: RequestFunction;
+    storage?: SimpleStorage;
+    anonymousSignInFunc?: (Credentials: any) => Promise<Credentials | void>;
+    captchaOptions?: Partial<CaptchaOptions>;
+    env?: string;
+    wxCloud?: any;
+    adapter?: SDKAdapterInterface;
+    onCredentialsError?: (data: {
+        msg: string;
+        eventType?: 'credentials_error';
+    }) => void;
+    headers?: {
+        [key: string]: string;
+    };
+    i18n?: ICloudbaseConfig['i18n'];
+    useWxCloud?: boolean;
+    eventBus?: any;
+    detectSessionInUrl?: boolean;
+    debug?: boolean;
+}
+export declare class Auth {
+    private static parseParamsToSearch;
+    private config;
+    private getCustomSignTicketFn?;
+    constructor(opts: AuthOptions);
+    getParamsByVersion(params: any, key: string): {
+        params: any;
+        url: any;
+    };
+    signIn(params: SignInRequest): Promise<Credentials>;
+    signInAnonymously(data?: {
+        provider_token?: string;
+    }, useWxCloud?: boolean): Promise<Credentials>;
+    signUp(params: SignUpRequest): Promise<Credentials>;
+    signOut(params?: SignoutRequest): Promise<SignoutResponse>;
+    revokeAllDevices(): Promise<void>;
+    revokeDevice(params: RevokeDeviceRequest): Promise<void>;
+    getVerification(params: GetVerificationRequest, options?: {
+        withCaptcha: boolean;
+    }): Promise<GetVerificationResponse>;
+    verify(params: VerifyRequest): Promise<VerifyResponse>;
+    genProviderRedirectUri(params: GenProviderRedirectUriRequest): Promise<GenProviderRedirectUriResponse>;
+    grantProviderToken(params: GrantProviderTokenRequest, useWxCloud?: boolean): Promise<GrantProviderTokenResponse>;
+    patchProviderToken(params: PatchProviderTokenRequest): Promise<PatchProviderTokenResponse>;
+    signInWithProvider(params: SignInWithProviderRequest, useWxCloud?: boolean): Promise<Credentials>;
+    toBindIdentity(params: {
+        provider_token: string;
+        provider: string;
+        credentials?: Credentials;
+        fireEvent?: boolean;
+    }): Promise<any>;
+    getInitialSession(): Promise<{
+        data: {
+            session: Credentials;
+            user?: any;
+        } | null;
+        error: Error | null;
+    }>;
+    signInCustom(params: SignInCustomRequest): Promise<Credentials>;
+    signInWithWechat(params?: any): Promise<Credentials>;
+    bindWithProvider(params: BindWithProviderRequest, credentials?: Credentials): Promise<void>;
+    getUserProfile(params: {
+        version?: string;
+    }): Promise<UserProfile>;
+    getUserInfo(params?: {
+        version?: string;
+        query?: string;
+        credentials?: Credentials;
+    }): Promise<UserInfo>;
+    getWedaUserInfo(): Promise<any>;
+    deleteMe(params: WithSudoRequest): Promise<UserProfile>;
+    hasLoginState(): Promise<boolean>;
+    hasLoginStateSync(): Credentials | null;
+    getLoginState(): Promise<Credentials | null>;
+    transByProvider(params: TransByProviderRequest): Promise<Credentials>;
+    grantToken(params: GrantTokenRequest): Promise<Credentials>;
+    getProviders(): Promise<ProvidersResponse>;
+    unbindProvider(params: UnbindProviderRequest): Promise<void>;
+    checkPassword(params: CheckPasswordRequest): Promise<void>;
+    editContact(params: EditContactRequest): Promise<void>;
+    setPassword(params: SetPasswordRequest): Promise<void>;
+    updatePasswordByOld(params: UpdatePasswordRequest): Promise<void>;
+    sudo(params: SudoRequest): Promise<SudoResponse>;
+    sendVerificationCodeToCurrentUser(params: GetVerificationRequest): Promise<GetVerificationResponse>;
+    changeBoundProvider(params: ChangeBoundProviderRequest): Promise<ChangeBoundProviderResponse>;
+    setUserProfile(params: UserProfile): Promise<UserProfile>;
+    updateUserBasicInfo(params: ModifyUserBasicInfoRequest): Promise<void>;
+    queryUserProfile(params: QueryUserProfileRequest): Promise<QueryUserProfileResponse>;
+    setCustomSignFunc(getTickFn: GetCustomSignTicketFn): void;
+    signInWithCustomTicket(): Promise<Credentials>;
+    resetPassword(params: ResetPasswordRequest): Promise<void>;
+    authorize(params: AuthorizeRequest): Promise<AuthorizeResponse>;
+    authorizeDevice(params: AuthorizeDeviceRequest): Promise<void>;
+    deviceAuthorize(params: DeviceAuthorizeRequest): Promise<DeviceAuthorizeResponse>;
+    authorizeInfo(params: AuthorizeInfoRequest): Promise<AuthorizeInfoResponse>;
+    checkUsername(params: CheckUsernameRequest): Promise<void>;
+    checkIfUserExist(params: CheckIfUserExistRequest): Promise<CheckIfUserExistResponse>;
+    loginScope(): Promise<string>;
+    loginGroups(): Promise<string[]>;
+    refreshTokenForce(params: {
+        version?: string;
+    }): Promise<Credentials>;
+    getCredentials(): Promise<Credentials>;
+    getPublicKey(): Promise<PublicKey>;
+    getEncryptParams(params: Record<any, any>): Promise<EncryptParams>;
+    getProviderSubType(): Promise<ProviderSubType>;
+    verifyCaptchaData({ token, key }: {
+        token: string;
+        key: string;
+    }): Promise<{
+        captcha_token: string;
+        expires_in: number;
+    }>;
+    createCaptchaData({ state, redirect_uri }: {
+        state: any;
+        redirect_uri?: any;
+    }): Promise<{
+        token: string;
+        data: string;
+    }>;
+    getMiniProgramCode(params: GetMiniProgramQrCodeRequest): Promise<GetMiniProgramQrCodeResponse>;
+    getMiniProgramQrCodeStatus(params: GetMiniProgramQrCodeStatusRequest): Promise<GetMiniProgramQrCodeStatusResponse>;
+    getUserBehaviorLog(params: GetUserBehaviorLog): Promise<GetUserBehaviorLogRes>;
+    modifyPassword(params: ModifyUserBasicInfoRequest): Promise<void>;
+    modifyPasswordWithoutLogin(params: ModifyPasswordWithoutLoginRequest): Promise<void>;
+    private restoreUrlState;
+}

package/dist/esm/auth/auth-error.d.ts

@@ -0,0 +1,6 @@
+export declare class AuthError extends Error {
+    code: (string & {}) | undefined;
+    status: number | undefined;
+    protected __isAuthError: boolean;
+    constructor(error: any);
+}

package/dist/esm/auth/consts.d.ts

@@ -0,0 +1,132 @@
+export declare const AUTH_API_PREFIX = "/auth";
+export declare enum ApiUrls {
+    AUTH_SIGN_UP_URL = "/v1/signup",
+    AUTH_TOKEN_URL = "/v1/token",
+    AUTH_REVOKE_URL = "/v1/revoke",
+    WEDA_USER_URL = "/v1/plugin/weda/userinfo",
+    AUTH_RESET_PASSWORD = "/v1/reset",
+    AUTH_GET_DEVICE_CODE = "/v1/device/code",
+    CHECK_USERNAME = "/v1/checkUsername",
+    CHECK_IF_USER_EXIST = "/v1/checkIfUserExist",
+    GET_PROVIDER_TYPE = "/v1/mgr/provider/providerSubType",
+    AUTH_SIGN_IN_URL = "/v1/signin",
+    AUTH_SIGN_IN_ANONYMOUSLY_URL = "/v1/signin/anonymously",
+    AUTH_SIGN_IN_WITH_PROVIDER_URL = "/v1/signin/with/provider",
+    AUTH_SIGN_IN_WITH_WECHAT_URL = "/v1/signin/wechat/noauth",
+    AUTH_SIGN_IN_CUSTOM = "/v1/signin/custom",
+    PROVIDER_TOKEN_URL = "/v1/provider/token",
+    PROVIDER_URI_URL = "/v1/provider/uri",
+    USER_ME_URL = "/v1/user/me",
+    AUTH_SIGNOUT_URL = "/v1/user/signout",
+    USER_QUERY_URL = "/v1/user/query",
+    USER_PRIFILE_URL = "/v1/user/profile",
+    USER_BASIC_EDIT_URL = "/v1/user/basic/edit",
+    USER_TRANS_BY_PROVIDER_URL = "/v1/user/trans/by/provider",
+    PROVIDER_LIST = "/v1/user/provider",
+    PROVIDER_BIND_URL = "/v1/user/provider/bind",
+    PROVIDER_UNBIND_URL = "/v1/user/provider",
+    CHECK_PWD_URL = "/v1/user/sudo",
+    SUDO_URL = "/v1/user/sudo",
+    BIND_CONTACT_URL = "/v1/user/contact",
+    AUTH_SET_PASSWORD = "/v1/user/password",
+    AUTHORIZE_DEVICE_URL = "/v1/user/device/authorize",
+    AUTHORIZE_URL = "/v1/user/authorize",
+    AUTHORIZE_INFO_URL = "/v1/user/authorize/info",
+    AUTHORIZED_DEVICES_DELETE_URL = "/v1/user/authorized/devices/",
+    AUTH_REVOKE_ALL_URL = "/v1/user/revoke/all",
+    GET_USER_BEHAVIOR_LOG = "/v1/user/security/history",
+    VERIFICATION_URL = "/v1/verification",
+    VERIFY_URL = "/v1/verification/verify",
+    CAPTCHA_DATA_URL = "/v1/captcha/data",
+    VERIFY_CAPTCHA_DATA_URL = "/v1/captcha/data/verify",
+    GET_CAPTCHA_URL = "/v1/captcha/init",
+    GET_MINIPROGRAM_QRCODE = "/v1/qrcode/generate",
+    GET_MINIPROGRAM_QRCODE_STATUS = "/v1/qrcode/get/status"
+}
+export declare enum ApiUrlsV2 {
+    AUTH_SIGN_IN_URL = "/v2/signin/username",
+    AUTH_TOKEN_URL = "/v2/token",
+    USER_ME_URL = "/v2/user/me",
+    VERIFY_URL = "/v2/signin/verificationcode",
+    AUTH_SIGN_IN_WITH_PROVIDER_URL = "/v2/signin/with/provider",
+    AUTH_PUBLIC_KEY = "/v2/signin/publichkey",
+    AUTH_RESET_PASSWORD = "/v2/signin/password/update"
+}
+export declare enum VerificationUsages {
+    REGISTER = "REGISTER",
+    SIGN_IN = "SIGN_IN",
+    PASSWORD_RESET = "PASSWORD_RESET",
+    EMAIL_ADDRESS_CHANGE = "EMAIL_ADDRESS_CHANGE",
+    PHONE_NUMBER_CHANGE = "PHONE_NUMBER_CHANGE"
+}
+export declare enum ErrorType {
+    UNREACHABLE = "unreachable",
+    LOCAL = "local",
+    CANCELLED = "cancelled",
+    UNKNOWN = "unknown",
+    UNAUTHENTICATED = "unauthenticated",
+    RESOURCE_EXHAUSTED = "resource_exhausted",
+    FAILED_PRECONDITION = "failed_precondition",
+    INVALID_ARGUMENT = "invalid_argument",
+    DEADLINE_EXCEEDED = "deadline_exceeded",
+    NOT_FOUND = "not_found",
+    ALREADY_EXISTS = "already_exists",
+    PERMISSION_DENIED = "permission_denied",
+    ABORTED = "aborted",
+    OUT_OF_RANGE = "out_of_range",
+    UNIMPLEMENTED = "unimplemented",
+    INTERNAL = "internal",
+    UNAVAILABLE = "unavailable",
+    DATA_LOSS = "data_loss",
+    INVALID_PASSWORD = "invalid_password",
+    PASSWORD_NOT_SET = "password_not_set",
+    INVALID_STATUS = "invalid_status",
+    USER_PENDING = "user_pending",
+    USER_BLOCKED = "user_blocked",
+    INVALID_VERIFICATION_CODE = "invalid_verification_code",
+    TWO_FACTOR_REQUIRED = "two_factor_required",
+    INVALID_TWO_FACTOR = "invalid_two_factor",
+    INVALID_TWO_FACTOR_RECOVERY = "invalid_two_factor_recovery",
+    UNDER_REVIEW = "under_review",
+    INVALID_REQUEST = "invalid_request",
+    UNAUTHORIZED_CLIENT = "unauthorized_client",
+    ACCESS_DENIED = "access_denied",
+    UNSUPPORTED_RESPONSE_TYPE = "unsupported_response_type",
+    INVALID_SCOPE = "invalid_scope",
+    INVALID_GRANT = "invalid_grant",
+    SERVER_ERROR = "server_error",
+    TEMPORARILY_UNAVAILABLE = "temporarily_unavailable",
+    INTERACTION_REQUIRED = "interaction_required",
+    LOGIN_REQUIRED = "login_required",
+    ACCOUNT_SELECTION_REQUIRED = "account_selection_required",
+    CONSENT_REQUIRED = "consent_required",
+    INVALID_REQUEST_URI = "invalid_request_uri",
+    INVALID_REQUEST_OBJECT = "invalid_request_object",
+    REQUEST_NOT_SUPPORTED = "request_not_supported",
+    REQUEST_URI_NOT_SUPPORTED = "request_uri_not_supported",
+    REGISTRATION_NOT_SUPPORTED = "registration_not_supported",
+    CAPTCHA_REQUIRED = "captcha_required",
+    CAPTCHA_INVALID = "captcha_invalid"
+}
+export declare const LOGIN_STATE_CHANGED_TYPE: {
+    SIGN_OUT: string;
+    SIGN_IN: string;
+    CREDENTIALS_ERROR: string;
+};
+export declare const AUTH_STATE_CHANGED_TYPE: {
+    SIGNED_OUT: string;
+    SIGNED_IN: string;
+    INITIAL_SESSION: string;
+    PASSWORD_RECOVERY: string;
+    TOKEN_REFRESHED: string;
+    USER_UPDATED: string;
+    BIND_IDENTITY: string;
+};
+export declare const EVENTS: {
+    LOGIN_STATE_CHANGED: string;
+    AUTH_STATE_CHANGED: string;
+};
+export declare const OAUTH_TYPE: {
+    SIGN_IN: string;
+    BIND_IDENTITY: string;
+};