@authing/react-ui-components 4.0.4-alpha.0 → 4.0.4-rc.0

package/types/Type/index.d.ts

@@ -0,0 +1,84 @@
+import { AuthenticationClient, CommonMessage, User } from 'authing-js-sdk';
+import { GuardModuleType } from '../Guard/module';
+import { FacePlugin } from '../_utils/facePlugin/interface';
+import { ApplicationConfig } from './application';
+export * from './application';
+export type { CommonMessage, User };
+export declare type Lang = 'zh-CN' | 'en-US' | 'zh-TW';
+export declare enum GuardMode {
+    Modal = "modal",
+    Normal = "normal"
+}
+export interface IG2FCProps extends IG2Events {
+    appId?: string;
+    tenantId?: string;
+    config?: Partial<IG2Config>;
+    visible?: boolean;
+    initData?: any;
+    appendConfig?: GuardAppendConfig;
+    facePlugin?: FacePlugin;
+    authClient?: AuthenticationClient;
+}
+export interface GuardAppendConfig {
+    internalRequest?: boolean;
+    singleComponent?: boolean;
+    unAuthFlow?: boolean;
+    publicConfig?: ApplicationConfig;
+    pageConfig?: GuardPageConfig;
+}
+export interface IG2FCViewProps extends IG2FCProps {
+    config: IG2Config;
+}
+export interface IG2Config {
+    title?: string;
+    logo?: string;
+    lang?: string;
+    langRange?: string[];
+    host: string;
+    isHost?: boolean;
+    mode: GuardMode;
+    clickCloseable: boolean;
+    escCloseable: boolean;
+    userpool?: string;
+    contentCss?: string;
+    target?: HTMLElement | string;
+    __internalRequest__?: boolean;
+    __singleComponent__?: boolean;
+    __unAuthFlow__?: boolean;
+}
+export interface IG2Events {
+    onLoad?: (authClient: AuthenticationClient) => void;
+    onLoadError?: (error: CommonMessage) => void;
+    onClose?: () => void;
+    onLangChange?: (lang: Lang) => void;
+    __changeModule?: (moduleName: GuardModuleType, initData?: any) => void;
+}
+export declare const getDefaultG2Config: () => IG2Config;
+export declare const LanguageMap: any;
+export declare enum InputMethod {
+    EmailCode = "email-code",
+    PhoneCode = "phone-code"
+}
+export declare enum GuardPageSene {
+    Global = "global"
+}
+export interface GuardPageConfig {
+    [GuardPageSene.Global]: {
+        showChangeLanguage: boolean;
+        defaultLanguage: Lang | 'browser';
+    };
+}
+export declare enum EmailScene {
+    WELCOME_EMAIL = "WELCOME_EMAIL",
+    FIRST_CREATED_USER = "FIRST_CREATED_USER",
+    REGISTER_VERIFY_CODE = "REGISTER_VERIFY_CODE",
+    LOGIN_VERIFY_CODE = "LOGIN_VERIFY_CODE",
+    MFA_VERIFY_CODE = "MFA_VERIFY_CODE",
+    INFORMATION_COMPLETION_VERIFY_CODE = "INFORMATION_COMPLETION_VERIFY_CODE",
+    FIRST_EMAIL_LOGIN_VERIFY = "FIRST_EMAIL_LOGIN_VERIFY",
+    CONSOLE_CONDUCTED_VERIFY = "CONSOLE_CONDUCTED_VERIFY",
+    RESET_PASSWORD_VERIFY_CODE = "RESET_PASSWORD_VERIFY_CODE",
+    EMAIL_BIND_VERIFY_CODE = "EMAIL_BIND_VERIFY_CODE",
+    EMAIL_UNBIND_VERIFY_CODE = "EMAIL_UNBIND_VERIFY_CODE",
+    SELF_UNLOCKING_VERIFY_CODE = "SELF_UNLOCKING_VERIFY_CODE"
+}

package/types/UploadImage/index.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+export declare const UploadImage: FC<{
+    value?: string;
+    onChange?: (value: string) => void;
+}>;

package/types/ValidatorRules/PasswordFormItem.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { PasswordFormItemProps } from '.';
+export interface ExPasswordFormItemProps extends PasswordFormItemProps {
+    fieldRequiredRuleMessage?: string;
+}
+export declare const PasswordFormItem: React.FC<ExPasswordFormItemProps>;

package/types/ValidatorRules/ValidatorFormItem.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+import { ValidatorFormItemProps } from '.';
+export declare const EmailFormItem: React.FC<ValidatorFormItemProps>;
+export declare const PhoneFormItem: React.FC<ValidatorFormItemProps>;
+export declare const UserNameFormItem: React.FC<ValidatorFormItemProps>;

package/types/ValidatorRules/api/index.d.ts

@@ -0,0 +1 @@
+export { validateAccountByAxios } from 'service/api';

package/types/ValidatorRules/index.d.ts

@@ -0,0 +1,31 @@
+import { FormInstance, FormItemProps } from 'antd/lib/form';
+import FormItem from 'antd/lib/form/FormItem';
+import { PasswordFormItem } from './PasswordFormItem';
+import { EmailFormItem, PhoneFormItem, UserNameFormItem } from './ValidatorFormItem';
+export interface ValidatorFormItemProps extends FormItemProps {
+    form?: FormInstance;
+    checkRepeat?: boolean;
+    checkExist?: boolean;
+    areaCode?: string;
+    /**
+     * 控制内部FormItem组件关于pattern的校验规则
+     */
+    isCheckPattern?: boolean;
+}
+export interface ValidatorFormItemMetaProps extends ValidatorFormItemProps {
+    method: 'email' | 'phone' | 'username';
+}
+export interface PasswordFormItemProps extends FormItemProps {
+}
+export interface ICheckProps {
+    check: (values: any) => void;
+}
+declare type InternalFormItemType = typeof FormItem;
+interface FormItemInterface extends InternalFormItemType {
+    Password: typeof PasswordFormItem;
+    Email: typeof EmailFormItem;
+    Phone: typeof PhoneFormItem;
+    UserName: typeof UserNameFormItem;
+}
+declare const CustomFormItem: FormItemInterface;
+export default CustomFormItem;

package/types/ValidatorRules/useCheckRepeat.d.ts

@@ -0,0 +1 @@
+export declare const useCheckRepeat: (checkFn: (value: any, resolve: (value: unknown) => void, reject: (reason?: any) => void) => void) => (_: any, value: any) => Promise<unknown>;

package/types/VerifyCodeInput/index.d.ts

@@ -0,0 +1,10 @@
+import React, { FC } from 'react';
+import './style.less';
+interface VerifyCodeInputProps extends React.HTMLAttributes<HTMLDivElement> {
+    verifyCode: string[];
+    setVerifyCode: (code: string[]) => void;
+    length?: number;
+    onEnter?: Function;
+}
+export declare const VerifyCodeInput: FC<VerifyCodeInputProps>;
+export {};

package/types/_utils/GuardErrorCode.d.ts

@@ -0,0 +1,11 @@
+export declare enum ErrorCode {
+    OTP_MFA_CODE = 1635,
+    APP_MFA_CODE = 1636,
+    INPUT_CAPTCHACODE = 2000,
+    USER_EXISTENCE = 2026,
+    LOGIN_INVALID = 2021,
+    PASSWORD_ERROR = 2333,
+    USER_NOT_EXIST = 2004,
+    MULTIPLE_ERROR_LOCK = 2057,
+    ACCOUNT_LOCK = 2005
+}

package/types/_utils/actions/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Response Action 是否为渲染信息
+ * @param parseStatusCode
+ * @returns
+ */
+export declare const isRenderMessageByStatusCode: (parseStatusCode: number) => boolean;
+/**
+ * Response Action 是否为内部流程状态处理（交由业务处理）
+ * @param parseStatusCode
+ * @param apiCode
+ */
+export declare const isFlowBusinessByStatusCode: (parseStatusCode: number) => boolean;
+/**
+ * Response Action 是否为流程结束
+ * @param parseStatusCode
+ * @param apiCode
+ */
+export declare const isFlowEndByStatusCode: (parseStatusCode: number, apiCode: number) => boolean;
+/**
+ * Response Action 是否为下个流程
+ * @param parseStatusCode
+ */
+export declare const isNextFlowByStatusCode: (parseStatusCode: number, apiCode: number) => boolean;

package/types/_utils/appendConfig.d.ts

@@ -0,0 +1,4 @@
+import { GuardAppendConfig } from '..';
+export declare const getAppendConfig: () => GuardAppendConfig;
+export declare const useAppendConfig: () => GuardAppendConfig;
+export declare const initAppendConfig: (appendConfig?: GuardAppendConfig) => void;

package/types/_utils/clipboard.d.ts

@@ -0,0 +1 @@
+export declare const copyToClipboard: (str: string) => void;

package/types/_utils/config/index.d.ts

@@ -0,0 +1,96 @@
+/// <reference types="react" />
+import { GuardComponentConfig, GuardLocalConfig } from '../../Guard/config';
+import { GuardHttp } from '../guardHttp';
+import { GuardPageConfig } from '../../Type';
+import { ApplicationConfig, RegisterMethods } from '../../Type/application';
+export declare const getPublicConfig: (appId: string) => ApplicationConfig;
+export declare const setPublicConfig: (appId: string, config: ApplicationConfig) => ApplicationConfig;
+export declare const useMergeDefaultConfig: (defaultConfig: GuardLocalConfig, config?: GuardComponentConfig | undefined) => GuardLocalConfig | undefined;
+export declare const useMergePublicConfig: (forceUpdate: number, appId?: string | undefined, config?: GuardLocalConfig | undefined, httpClient?: GuardHttp | undefined, setError?: any) => {
+    host: string;
+    isSSO?: boolean | undefined;
+    defaultScenes?: import("../..").GuardModuleType | undefined;
+    defaultInitData?: any;
+    showLoading?: boolean | undefined;
+    loadingComponent?: import("react").ReactNode;
+    openEventsMapping?: boolean | undefined;
+    _qrCodeScanOptions?: Record<import("../../Guard/config").QrCodeScanType, import("../../Guard/config").QrCodeScanOptions> | undefined;
+    disableRegister?: boolean | undefined;
+    registerMethods?: RegisterMethods[] | undefined;
+    defaultRegisterMethod?: RegisterMethods | undefined;
+    publicKey?: string | undefined;
+    agreementEnabled?: boolean | undefined;
+    agreements?: import("../../Type").Agreement[] | undefined;
+    registerContext?: any;
+    title?: string | undefined;
+    logo?: string | undefined;
+    lang?: string | undefined;
+    langRange?: string[] | undefined;
+    isHost?: boolean | undefined;
+    mode: import("../../Type").GuardMode;
+    clickCloseable: boolean;
+    escCloseable: boolean;
+    userpool?: string | undefined;
+    contentCss?: string | undefined;
+    target?: string | HTMLElement | undefined;
+    __internalRequest__?: boolean | undefined;
+    __singleComponent__?: boolean | undefined;
+    __unAuthFlow__?: boolean | undefined;
+    autoRegister?: boolean | undefined;
+    disableResetPwd?: boolean | undefined;
+    defaultLoginMethod?: import("../../Type").LoginMethods | undefined;
+    loginMethods?: import("../../Type").LoginMethods[] | undefined;
+    passwordLoginMethods?: import("../../Type").PasswordLoginMethods[] | undefined;
+    socialConnections?: import("authing-js-sdk").SocialConnectionProvider[] | undefined;
+    socialConnectionsBtnShape?: "default" | "button" | "icon" | undefined;
+    enterpriseConnections?: string[] | undefined;
+    qrCodeScanOptions?: {
+        extIdpConnId?: string | undefined;
+        autoExchangeUserInfo?: boolean | undefined;
+        size?: {
+            height: number;
+            width: number;
+        } | undefined;
+        containerSize?: {
+            height: number;
+            width: number;
+        } | undefined;
+        interval?: number | undefined;
+        onStart?: ((timer: any) => any) | undefined;
+        onResult?: ((data: import("authing-js-sdk").QRCodeStatus) => any) | undefined;
+        onScanned?: ((userInfo: import("authing-js-sdk").QRCodeUserInfo) => any) | undefined;
+        onSuccess?: ((userInfo: import("authing-js-sdk").QRCodeUserInfo, ticket: string) => any) | undefined;
+        onCancel?: (() => any) | undefined;
+        onError?: ((message: string) => any) | undefined;
+        onExpired?: (() => any) | undefined;
+        onCodeShow?: ((random: string, url: string) => any) | undefined;
+        onCodeLoaded?: ((random: string, url: string) => any) | undefined;
+        onCodeLoadFailed?: ((message: string) => any) | undefined;
+        onCodeDestroyed?: ((random: string) => any) | undefined;
+        onRetry?: (() => any) | undefined;
+        onMfa?: ((code: number, message: string, data: Record<string, any>) => {}) | undefined;
+        tips?: {
+            title?: string | undefined;
+            scanned?: string | undefined;
+            succeed?: string | undefined;
+            canceled?: string | undefined;
+            expired?: string | undefined;
+            retry?: string | undefined;
+            failed?: string | undefined;
+            middleTitle?: string | undefined;
+            referText?: string | undefined;
+        } | undefined;
+        onAuthFlow?: ((flow: Record<string, any>) => {}) | undefined;
+        customData?: {
+            [x: string]: any;
+        } | undefined;
+        context?: {
+            [x: string]: any;
+        } | undefined;
+        withCustomData?: boolean | undefined;
+    } | undefined;
+} | undefined;
+export declare const getPageConfig: (appId: string) => GuardPageConfig;
+export declare const setPageConfig: (appId: string, config: GuardPageConfig) => GuardPageConfig;
+export declare const requestGuardPageConfig: (appId: string, httpClient: GuardHttp) => Promise<GuardPageConfig>;
+export declare const useGuardPageConfig: (forceUpdate: number, appId?: string | undefined, httpClient?: GuardHttp | undefined, serError?: any) => GuardPageConfig | undefined;

package/types/_utils/context.d.ts

@@ -0,0 +1,139 @@
+import React from 'react';
+import { GuardEvents, GuardLocalConfig, GuardModuleType, GuardPageConfig } from '..';
+import { BackFillMultipleState, StoreInstance } from '../Guard/core/hooks/useMultipleAccounts';
+import { ModuleState } from '../Guard/GuardModule/stateMachine';
+import { ApplicationConfig } from '../Type/application';
+import { GuardHttp } from './guardHttp';
+export interface IGuardContext {
+    finallyConfig: GuardLocalConfig;
+    defaultMergedConfig: GuardLocalConfig;
+    publicConfig: ApplicationConfig;
+    httpClient: GuardHttp;
+    appId: string;
+    tenantId?: string;
+    initData: any;
+    currentModule: ModuleState;
+    events: Partial<GuardEvents>;
+    changeModule?: (moduleName: GuardModuleType, initData?: any) => Promise<void>;
+    backModule?: () => void;
+    isAuthFlow: boolean;
+    contextLoaded: boolean;
+    guardPageConfig: Partial<GuardPageConfig>;
+    multipleInstance: {
+        /**
+         * 多账号相关
+         */
+        isMultipleAccount: boolean;
+        /**
+         * when： 多账号页面跳转进入登录页面
+         * 携带的回填数据信息
+         */
+        multipleAccountData?: BackFillMultipleState;
+        /**
+         * 多账号 store 实例
+         */
+        instance?: StoreInstance;
+        /**
+         * 切换多账号 isMultipleAccount 状态
+         */
+        referMultipleState?: (type: 'login' | 'multiple') => void;
+        /**
+         * 清空回填数据
+         */
+        clearBackFillData?: () => void;
+    };
+}
+export declare const createGuardXContext: () => {
+    Provider: React.FC<{
+        value: Partial<IGuardContext>;
+    }>;
+    Consumer: React.Consumer<IGuardContext>;
+};
+export declare const useGuardXContext: () => {
+    Provider: React.FC<{
+        value: Partial<IGuardContext>;
+    }>;
+    Consumer: React.Consumer<IGuardContext>;
+};
+export interface IGuardContextProvider {
+    spin: boolean;
+    spinChange: (spin: boolean) => void;
+}
+export declare const useGuardButtonContext: () => {
+    GuardButtonProvider: React.FC<{}>;
+};
+export declare const useGuardButtonState: () => IGuardContextProvider;
+export declare const useGuardPublicConfig: () => ApplicationConfig;
+export declare const useGuardHttpClient: () => GuardHttp;
+export declare const useGuardDefaultMergedConfig: () => GuardLocalConfig;
+export declare const useGuardAppId: () => string;
+export declare const useGuardTenantId: () => string | undefined;
+export declare function useGuardInitData<T>(): T;
+export declare const useGuardCurrentModule: () => ModuleState;
+export declare const useGuardEvents: () => Partial<GuardEvents>;
+export declare const useGuardModule: () => {
+    changeModule: ((moduleName: GuardModuleType, initData?: any) => Promise<void>) | undefined;
+    backModule: (() => void) | undefined;
+};
+export declare const useGuardFinallyConfig: () => GuardLocalConfig;
+export declare const useGuardContextLoaded: () => boolean;
+export declare const useGuardIsAuthFlow: () => boolean;
+export declare const useGuardPageConfig: () => Partial<GuardPageConfig>;
+/**
+ * 多账号登录 store 实例
+ */
+export declare const useGuardMultipleInstance: () => {
+    /**
+     * 多账号相关
+     */
+    isMultipleAccount: boolean;
+    /**
+     * when： 多账号页面跳转进入登录页面
+     * 携带的回填数据信息
+     */
+    multipleAccountData?: BackFillMultipleState | undefined;
+    /**
+     * 多账号 store 实例
+     */
+    instance?: {
+        initStore: (appId: string, options: {
+            serverSideLoginMethods: import("../Guard/core/hooks/useMultipleAccounts").LoginWay[];
+            isInternationSms: boolean;
+        }) => void;
+        setLoginWay: (tab: "input" | "qrcode", way: import("../Guard/core/hooks/useMultipleAccounts").LoginWay, id?: string | undefined, internation?: {
+            phoneCountryCode: string;
+            areaCode: string;
+        } | undefined) => void;
+        setUserInfo: (user: Pick<import("../Guard/core/hooks/useMultipleAccounts").User & {
+            id: string;
+        }, "email" | "username" | "phone" | "photo" | "id" | "name" | "nickname" | "_updateTime" | "qrCodeId" | "areaCode">) => void;
+        setLoginWayByHttpData: (account: string, data: {
+            username?: string | undefined;
+            phone?: string | undefined;
+            email?: string | undefined;
+        }) => void;
+        setLoginWayByLDAPData: (account: string, data: {
+            name?: string | undefined;
+            phone?: string | undefined;
+            email?: string | undefined;
+        }) => void;
+        getMemoUser: (excludeWays?: import("../Guard/core/hooks/useMultipleAccounts").LoginWay[]) => import("../Login/multipleAccounts/panel").SelectOptions[];
+        getMemoSingleUser: (id: string) => {
+            way: import("../Guard/core/hooks/useMultipleAccounts").LoginWay;
+            account: string;
+        } | undefined;
+        delUserById: (id: string) => string;
+        getMemberState: () => boolean;
+        getFirstBackFillData: () => BackFillMultipleState | undefined;
+        getOriginAccount: () => string;
+        getOriginWay: () => string;
+    } | undefined;
+    /**
+     * 切换多账号 isMultipleAccount 状态
+     */
+    referMultipleState?: ((type: 'login' | 'multiple') => void) | undefined;
+    /**
+     * 清空回填数据
+     */
+    clearBackFillData?: (() => void) | undefined;
+};

package/types/_utils/corsVerification.d.ts

@@ -0,0 +1 @@
+export declare const corsVerification: (allowedOrigins?: string[], corsWhitelist?: string[]) => void;

package/types/_utils/countryList.d.ts

@@ -0,0 +1,7 @@
+export interface IsoType {
+    iso: string;
+    regions: string;
+    regions_en: string;
+    phoneCountryCode: string;
+}
+export declare const isoInfo: IsoType[];

package/types/_utils/errorFace.d.ts

@@ -0,0 +1,12 @@
+declare enum FaceErrorName {
+    NotAllowedError = "NotAllowedError",
+    AbortError = "AbortError",
+    NotReadableError = "NotReadableError",
+    OverconstrainedError = "OverconstrainedError",
+    SecurityError = "SecurityError"
+}
+export interface FaceErrorMessage extends DOMException {
+    name: FaceErrorName;
+}
+export declare const faceErrorMessage: (error: FaceErrorMessage) => string;
+export {};

package/types/_utils/facePlugin/index.d.ts

@@ -0,0 +1,4 @@
+import { FacePlugin } from './interface';
+export declare const getFacePlugin: () => FacePlugin | undefined;
+export declare const useFacePlugin: () => FacePlugin | undefined;
+export declare const initFacePlugin: (facePlugin: FacePlugin) => FacePlugin;

package/types/_utils/facePlugin/interface.d.ts

@@ -0,0 +1,5 @@
+export interface FacePlugin {
+    detectSingleFace: any;
+    TinyFaceDetectorOptions: any;
+    nets: any;
+}

package/types/_utils/flowHandleStorage.d.ts

@@ -0,0 +1,4 @@
+export declare const getFlowHandle: () => string | undefined;
+export declare const useFlowHandle: () => string | undefined;
+export declare const updateFlowHandle: (flowHandle: string) => void;
+export declare const useUpdateFlowHandle: (flowHandle: string) => void;

package/types/_utils/guardDocument.d.ts

@@ -0,0 +1,3 @@
+export declare const getGuardDocument: () => Document;
+export declare const useAppendConfig: () => Document;
+export declare const initGuardDocument: (document: Document) => void;

package/types/_utils/guardHttp.d.ts

@@ -0,0 +1,27 @@
+import { AuthingGuardResponse, AuthingResponse } from './http';
+import { CodeAction } from './responseManagement/interface';
+export declare class GuardHttp {
+    private requestClient;
+    private headers;
+    private responseInterceptorMap;
+    constructor(baseUrl?: string);
+    private getRequestClient;
+    setUserpoolId(userpoolId: string): this;
+    setAppId(appId: string): this;
+    setTenantId(tenantId: string): this;
+    setBaseUrl(baseUrl: string): this;
+    getHeaders: () => Record<string, string>;
+    get: <T = any>(path: string, query?: Record<string, any>, config?: any) => Promise<AuthingGuardResponse<T>>;
+    post: <T = any>(path: string, data: any, config?: {
+        headers: any;
+    } | undefined) => Promise<AuthingGuardResponse<T>>;
+    postForm: <T = any>(path: string, formData: any, config?: {
+        headers: any;
+    } | undefined) => Promise<AuthingGuardResponse<T>>;
+    authFlow: <T = any>(action: string, data?: any) => Promise<AuthingGuardResponse<T>>;
+    initErrorCodeInterceptor: (callBack: (code: CodeAction, res: AuthingResponse) => AuthingGuardResponse) => this | undefined;
+    responseIntercept: (res: AuthingResponse) => AuthingGuardResponse;
+}
+export declare const initGuardHttp: (baseUrl: string) => GuardHttp;
+export declare const getGuardHttp: () => GuardHttp;
+export declare const useGuardHttp: () => GuardHttp;

package/types/_utils/hooks/index.d.ts

@@ -0,0 +1,43 @@
+import { GuardLocalConfig } from '../../Guard';
+import { ApplicationConfig } from '../../Type/application';
+export interface PhoneValidResult {
+    isValid: boolean;
+    phoneNumber: string;
+    countryIso2: string;
+    countryIso3: string;
+    countryCode: string;
+}
+export declare const HIDE_SOCIALS: string[];
+export declare const HIDE_SOCIALS_SHOWIN_ENTERPRISE: string[];
+export declare const useAppId: (appId?: string | undefined) => string;
+export declare const useDebounce: (fn: any, delay: number) => (...args: any[]) => void;
+export declare const useMediaSize: () => {
+    isPhoneMedia: boolean;
+};
+export declare const useShaking: () => {
+    MountShaking: () => void;
+    UnMountShaking: () => void;
+};
+/**
+ * 解析手机号
+ * @param fieldValue 字段值
+ * @param areaCode 区号
+ * @returns
+ */
+export declare const parsePhone: (isInternationSms: boolean, fieldValue: string, areaCode?: string) => {
+    countryCode: string | undefined;
+    phoneNumber: string;
+};
+export declare enum SocialConnectionEvent {
+    Message = "message",
+    Auth = "auth"
+}
+/**
+ *
+ * @param config
+ * @returns[socialConnectionObjs 社交身份源连接对象 enterpriseConnectionObjs 企业身份源连接对象 isNoMethod 是否没有身份源 ]
+ */
+export declare const useMethod: (params: {
+    config: GuardLocalConfig;
+    publicConfig: ApplicationConfig;
+}) => any;

package/types/_utils/http/api/constant.d.ts

@@ -0,0 +1,7 @@
+export declare const authFlowUrl: () => string;
+export declare const VerifyEmailUrl: () => string;
+export declare const validateAccountUrl: () => string;
+export declare const countryListsUrl: () => string;
+export declare const validatePhoneCodeUrl: () => string;
+export declare const validateEmailCodeUrl: () => string;
+export declare const sendPhoneCodeUrl: () => string;

package/types/_utils/http/api/index.d.ts

@@ -0,0 +1 @@
+export * from './request';

package/types/_utils/http/api/request.d.ts

@@ -0,0 +1,72 @@
+import { AxiosRequestConfig } from 'axios';
+import { EmailScene, SceneType } from 'components/Type';
+/**
+ * AuthFlow 相关请求
+ * @param data
+ */
+export declare const authFlowByAxios: <A = string, T = any>(data: {
+    action: A;
+    data?: any;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../http").AuthingGuardResponse<T>>;
+/**
+ * 发送邮箱验证码
+ * @param data
+ */
+export declare const sendEmailCodeByAxios: (data: {
+    email: string;
+    scene: EmailScene;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../http").AuthingGuardResponse<any>>;
+/**
+ * 账号登陆前置校验
+ */
+export interface ValidateAccountParams<T = any> {
+    /**
+     * publicConfig.userPoolId
+     */
+    userPoolId?: string;
+    /**
+     * 校验的输入值
+     */
+    key: T;
+    /**
+     * 本次校验类型
+     */
+    type: 'phone' | 'email' | 'username';
+}
+/**
+ * 登陆/注册 前置，校验(用户/手机/邮箱)是否存在/用户是否不存在
+ * @param params
+ * @returns {Promise<boolean>} 是否通过
+ */
+export declare const validateAccountByAxios: <T = boolean>(params: ValidateAccountParams) => Promise<import("../../http").AuthingGuardResponse<T>>;
+/**
+ * 拉取国家列表
+ */
+export declare const getCountryLists: <T extends string>() => Promise<import("../../http").AuthingGuardResponse<Record<T, {
+    zh: {
+        [props: string]: string;
+    };
+    cn: {
+        [props: string]: string;
+    };
+}>>>;
+/**
+ * 验证手机号验证码是否正确
+ */
+export declare const validatePhoneCodeByAxios: (data: {
+    phone: number | string;
+    phoneCode: number | string;
+    phoneCountryCode?: number | string;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../http").AuthingGuardResponse<any>>;
+/**
+ * 验证邮箱验证码是否正确
+ */
+export declare const validateEmailCodeByAxios: (data: {
+    email: number | string;
+    emailCode: number | string;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../http").AuthingGuardResponse<any>>;
+export declare const sendSmsCodeByAxios: (data: {
+    phone: string;
+    phoneCountryCode?: string;
+    scene?: SceneType;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../http").AuthingGuardResponse<any>>;

package/types/_utils/http/base/index.d.ts

@@ -0,0 +1,10 @@
+import { AuthenticationClient } from 'authing-js-sdk';
+/**
+ * 修改 baseUrl 配置
+ */
+export declare const setBaseUrl: (baseUrl: string) => void;
+export declare const setAuthClient: (client: AuthenticationClient) => void;
+/**
+ * 设置加密公钥
+ */
+export declare const setPublishByEncrypt: (publishKey?: string | undefined) => void;