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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@authing/react-ui-components",
-  "version": "4.0.4-alpha.0",
+  "version": "4.0.4-alpha.1",
   "private": false,
   "main": "lib/index.min.js",
   "typings": "types/index.d.ts",

package/types/AuthClientProvider/AuthClientProvider.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { AuthClientContextProps } from './context';
+export declare const AuthClientProvider: React.FC<AuthClientContextProps>;
+export declare const useGlobalAuthClient: () => import("authing-js-sdk").AuthenticationClient | undefined;

package/types/AuthClientProvider/context.d.ts

@@ -0,0 +1,6 @@
+import { AuthenticationClient } from 'authing-js-sdk';
+import React from 'react';
+export interface AuthClientContextProps {
+    client: AuthenticationClient;
+}
+export declare const AuthClientContext: React.Context<AuthClientContextProps | undefined>;

package/types/AuthClientProvider/index.d.ts

@@ -0,0 +1 @@
+export { AuthClientProvider, useGlobalAuthClient } from './AuthClientProvider';

package/types/Back/index.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import './styles.less';
+export interface BackProps {
+    isRender?: boolean;
+}
+export declare const BackLogin: React.FC<BackProps>;
+export interface BackCustomProps extends BackProps {
+    onBack?: () => void;
+}
+export declare const BackCustom: React.FC<BackCustomProps>;

package/types/BindTotp/api/constant.d.ts

@@ -0,0 +1,2 @@
+export declare const mfaAuthenticatorUrl: () => string;
+export declare const mfaTotpAssociateUrl: () => string;

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

@@ -0,0 +1,19 @@
+import { AxiosRequestConfig } from 'axios';
+export { authFlowByAxios } from 'service/api';
+/**
+ * 验证是否已登陆
+ * @param data
+ * @param config
+ */
+export declare const mfaTotpAuthenticatorByAxios: (params: {
+    source: string;
+}, config: AxiosRequestConfig) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;
+/**
+ * 已登陆 totp 拉取二维码、Secret 信息
+ * @param data
+ * @param config
+ * @returns
+ */
+export declare const mfaTotpAssociateByAxios: (data: {
+    source: string;
+}, config: AxiosRequestConfig) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;

package/types/BindTotp/businessRequest.d.ts

@@ -0,0 +1,5 @@
+export declare enum BindTotpBusinessAction {
+    VerifyTotpFirstTime = "verify-totp-first-time",
+    ConfirmTotpRecoveryCode = "confirm-totp-recovery-code"
+}
+export declare const authFlow: (action: BindTotpBusinessAction, content: any) => Promise<import("../_utils/http").AuthingGuardResponse<any>>;

package/types/BindTotp/core/bindSuccess.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+export interface BindSuccessProps {
+    onBind: any;
+    secret: string;
+}
+export declare const BindSuccess: React.FC<BindSuccessProps>;

package/types/BindTotp/core/securityCode.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+export interface SecurityCodeProps {
+    mfaToken: string;
+    qrcode: string;
+    onNext: any;
+    changeModule: any;
+}
+export declare const SecurityCode: React.FC<SecurityCodeProps>;

package/types/BindTotp/index.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import './styles.less';
+export declare const GuardBindTotpView: React.FC;

package/types/BindTotp/interface.d.ts

@@ -0,0 +1,20 @@
+import { IG2Config, IG2Events, IG2FCProps } from '../Type';
+import { GuardMFAInitData } from '../MFA/interface';
+import { AuthenticationClient, User } from 'authing-js-sdk';
+export interface BindTotpConfig extends IG2Config {
+    autoRegister: boolean;
+}
+export declare const getDefaultMFAConfig: () => BindTotpConfig;
+export interface BindTotpEvents extends IG2Events {
+    onLogin?: (user: User, authClient: AuthenticationClient) => void;
+}
+export interface GuardBindTotpInitData extends GuardMFAInitData {
+}
+export interface GuardBindTotpProps extends IG2FCProps, BindTotpEvents {
+    config: Partial<BindTotpConfig>;
+    initData: GuardBindTotpInitData;
+}
+export interface GuardBindTotpViewProps extends GuardBindTotpProps {
+    config: BindTotpConfig;
+    initData: GuardBindTotpInitData;
+}

package/types/ChangeLanguage/index.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { Lang } from '../Type';
+import './style.less';
+export declare const LngTextMapping: Record<Lang, {
+    label: string;
+}>;
+export declare const ChangeLanguage: (props: {
+    onLangChange?: ((lang: Lang) => void) | undefined;
+    langRange?: string[] | undefined;
+}) => JSX.Element | null;

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

@@ -0,0 +1,3 @@
+import { registerEmailCodeByAxios } from '../../Register/api/index';
+import { authFlowByAxios } from 'service/api';
+export { authFlowByAxios, registerEmailCodeByAxios };

package/types/ChangePassword/businessRequest.d.ts

@@ -0,0 +1,10 @@
+import { AxiosRequestConfig } from 'axios';
+export declare enum ChangePasswordBusinessAction {
+    ResetPassword = "reset-password-first-time",
+    FirstLoginReset = "reset-password-forced",
+    ResetPasswordStrengthDetection = "reset-password-strength-detection"
+}
+export declare const authFlow: (action: ChangePasswordBusinessAction, content: {
+    password: string;
+    oldPassword?: string;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../_utils/http").AuthingGuardResponse<any>>;

package/types/ChangePassword/core/PasswordNotSafeReset.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+interface PasswordNotSafeResetProps {
+    onReset: any;
+}
+export declare const PasswordNotSafeReset: React.FC<PasswordNotSafeResetProps>;
+export {};

package/types/ChangePassword/core/completePassword.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+/**
+ * 注册补全密码
+ * 进入流程：
+ * 1. 控制台登陆方式  短信验证码 && 手机号密码
+ * 2. 注册方式 短信验证码
+ */
+export declare const CompletePassword: React.FC;

package/types/ChangePassword/core/firstLoginReset.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+interface FirstLoginResetProps {
+    onReset: any;
+}
+export declare const FirstLoginReset: React.FC<FirstLoginResetProps>;
+export {};

package/types/ChangePassword/core/rotateReset.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+interface RotateResetProps {
+    onReset: any;
+    onFinishCallBack?: any;
+}
+export declare const RotateReset: (props: RotateResetProps) => JSX.Element;
+export {};

package/types/ChangePassword/index.d.ts

@@ -0,0 +1,22 @@
+import React from 'react';
+export declare const GuardChangePassword: React.FC<{
+    title: string;
+    explain: string;
+}>;
+/**
+ * 首次登陆重制密码
+ * @returns
+ */
+export declare const GuardFirstLoginPasswordResetView: React.FC;
+export declare const GuardPasswordNotSafeResetView: React.FC;
+export declare const GuardForcedPasswordResetView: React.FC;
+/**
+ * 提示修改密码
+ * @returns
+ */
+export declare const GuardNoticePasswordResetView: React.FC;
+/**
+ * 注册密码补全
+ * @returns
+ */
+export declare const GuardRegisterCompletePasswordView: React.FC;

package/types/CompleteInfo/api/constant.d.ts

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

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

@@ -0,0 +1,4 @@
+import { authFlowByAxios, getCountryLists, validateAccountByAxios, validateEmailCodeByAxios, validatePhoneCodeByAxios } from 'service/api';
+import { registerEmailCodeByAxios } from '../../Register/api/index';
+import { getRegisterMetadata } from './request';
+export { registerEmailCodeByAxios, authFlowByAxios, getCountryLists, validateAccountByAxios, validateEmailCodeByAxios, validatePhoneCodeByAxios, getRegisterMetadata, };

package/types/CompleteInfo/api/request.d.ts

@@ -0,0 +1,8 @@
+import { AxiosRequestConfig } from 'axios';
+/**
+ * 获取注册信息补全元数据
+ * @param params
+ * @param config
+ * @returns
+ */
+export declare const getRegisterMetadata: (params?: any, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;

package/types/CompleteInfo/businessRequest.d.ts

@@ -0,0 +1,15 @@
+import { AxiosRequestConfig } from 'axios';
+import { CompleteInfoRequest, RegisterCompleteInfoInitData } from './interface';
+export declare enum CompleteInfoAuthFlowAction {
+    Complete = "complete-completion",
+    Skip = "skip-completion"
+}
+export declare const authFlow: (action: CompleteInfoAuthFlowAction, data?: CompleteInfoRequest | undefined, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../_utils/http").AuthingGuardResponse<any>>;
+/**
+ * 注册点击跳过
+ * @param fnName
+ * @param content
+ * @returns
+ */
+export declare const registerSkipMethod: (fnName: RegisterCompleteInfoInitData['businessRequestName'], content: any) => Promise<import("../_utils/http").AuthingGuardResponse<any>> | undefined;
+export declare const registerRequest: (action: CompleteInfoAuthFlowAction, registerFnName: RegisterCompleteInfoInitData['businessRequestName'], registerContent: any, registerProfile?: any) => Promise<import("../_utils/http").AuthingGuardResponse<any> | undefined>;

package/types/CompleteInfo/core/completeInfo.d.ts

@@ -0,0 +1,16 @@
+import React from 'react';
+import { CompleteInfoMetaData, CompleteInfoRequest } from '../interface';
+export interface CompleteInfoProps {
+    metaData: CompleteInfoMetaData[];
+    businessRequest: (data: CompleteInfoRequest) => Promise<void>;
+}
+export interface FieldMetadata {
+    key: string;
+    options: any;
+}
+/**
+ * 信息补全
+ * @param props
+ * @returns
+ */
+export declare const CompleteInfo: React.FC<CompleteInfoProps>;

package/types/CompleteInfo/index.d.ts

@@ -0,0 +1,22 @@
+import React from 'react';
+import { CompleteInfoMetaData, CompleteInfoRequest } from './interface';
+import './styles.less';
+import { CompleteInfoAuthFlowAction } from './businessRequest';
+/**
+ * 登录时信息补全
+ * @param param0
+ * @returns
+ */
+export declare const GuardCompleteInfo: React.FC<{
+    metaData: CompleteInfoMetaData[];
+    skipComplateFileds: boolean;
+    businessRequest: (action: CompleteInfoAuthFlowAction, data?: CompleteInfoRequest) => Promise<void>;
+}>;
+/**
+ * 登录信息补全
+ */
+export declare const GuardLoginCompleteInfoView: React.FC;
+/**
+ * 注册信息补全
+ */
+export declare const GuardRegisterCompleteInfoView: React.FC;

package/types/CompleteInfo/interface.d.ts

@@ -0,0 +1,99 @@
+import { AuthenticationClient, CommonMessage, User } from 'authing-js-sdk';
+import { IG2Config, IG2Events, IG2FCProps } from '../Type';
+export interface CompleteInfoConfig extends IG2Config {
+}
+export declare const getDefaultCompleteInfoConfig: () => CompleteInfoConfig;
+export interface CompleteInfoEvents extends IG2Events {
+    onRegisterInfoCompleted?: (user: User, udfs: {
+        definition: any;
+        value: any;
+    }[], authClient: AuthenticationClient) => void;
+    onRegisterInfoCompletedError?: (error: CommonMessage, udfs: {
+        definition: any;
+        value: any;
+    }[], authClient: AuthenticationClient) => void;
+}
+export interface GuardCompleteInfoProps extends IG2FCProps, CompleteInfoEvents {
+    config: Partial<CompleteInfoConfig>;
+}
+export interface GuardCompleteInfoViewProps extends GuardCompleteInfoProps {
+    config: CompleteInfoConfig;
+    initData: any;
+    onLogin?: any;
+}
+export declare type ExtendsFieldType = 'user' | 'internal';
+export interface ExtendsField {
+    type: ExtendsFieldType;
+    name: string;
+    label: string;
+    inputType: string;
+    required: boolean;
+    validateRules: any[];
+}
+export declare enum FormValidateRule {
+    NONE = "none",
+    EMAIL = "email",
+    PHONE = "phone",
+    IS_NUMBER = "isNumber",
+    REG_EXP = "regExp"
+}
+export interface CompleteInfoRule {
+    type: FormValidateRule;
+    content: string;
+    errorMessage?: string;
+}
+export interface CompleteInfoSelectOption {
+    value: string;
+    label: string;
+}
+export interface CompleteInfoMetaData {
+    type: CompleteInfoBaseControls | CompleteInfoExtendsControls;
+    label: string;
+    name: string;
+    required: boolean;
+    validateRules: CompleteInfoRule[];
+    options?: CompleteInfoSelectOption[];
+}
+export declare enum CompleteInfoBaseControls {
+    USERNAME = "username",
+    PHONE = "phone",
+    EMAIL = "email"
+}
+export declare enum CompleteInfoExtendsControls {
+    IMAGE = "image",
+    NUMBER = "number",
+    DATE = "date",
+    DATE_TIME = "dateTime",
+    SELECT = "select",
+    DROPDOWN = "dropdown",
+    BOOLEAN = "boolean",
+    STRING = "string",
+    TEXT = "text",
+    GENDER = "gender",
+    COUNTRY = "country"
+}
+export interface CompleteInfoInitData {
+    skip: boolean;
+    metaData: CompleteInfoMetaData[];
+}
+export interface RegisterCompleteInfoInitData {
+    content: any;
+    businessRequestName: 'registerByEmail' | 'registerByPhoneCode' | 'registerByEmailCode';
+    onRegisterFailed: Function;
+    onRegisterSuccess: Function;
+}
+export interface RegisterCompletePasswordInitData extends RegisterCompleteInfoInitData {
+    isChangeComplete: boolean;
+}
+export interface CompleteInfoRequest {
+    fieldValues: {
+        name: string;
+        value: string;
+        code?: string;
+    }[];
+}
+export declare enum OmitCompleteInfo {
+    'registerByEmail' = "email",
+    'registerByPhoneCode' = "phone",
+    'registerByEmailCode' = "email"
+}

package/types/CompleteInfo/utils.d.ts

@@ -0,0 +1,16 @@
+import { User } from 'authing-js-sdk';
+import { CompleteInfoMetaData, ExtendsField } from '../CompleteInfo/interface';
+import { ApplicationConfig } from '../Type/application';
+export declare const completeFieldsFilter: (user: User, field: ExtendsField) => boolean;
+export declare const extendsFieldsToMetaData: (extendsFields: import("../Type/application").ExtendsField[] | undefined, selectOptions: {
+    key: string;
+    options: {
+        value: string;
+        label: string;
+    }[];
+}[]) => CompleteInfoMetaData[];
+export declare const fieldValuesToRegisterProfile: (extendsFields: ApplicationConfig['extendsFields'], fieldValues?: {
+    name: string;
+    value: string;
+    code?: string | undefined;
+}[] | undefined) => Record<string, any>;

package/types/CopyAbleText/index.d.ts

@@ -0,0 +1,5 @@
+import React, { FC } from 'react';
+import './style.less';
+export interface CopyTextProps extends React.HTMLAttributes<HTMLDivElement> {
+}
+export declare const CopyAbleText: FC<CopyTextProps>;

package/types/DownloadAuthenticator/index.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import './styles.less';
+export declare const GuardDownloadATView: React.FC;

package/types/DownloadAuthenticator/interface.d.ts

@@ -0,0 +1,12 @@
+import { IG2Config, IG2Events, IG2FCProps } from '../Type';
+export interface DownloadATConfig extends IG2Config {
+}
+export declare const getDefaultDownloadAuthenticatorConfig: () => DownloadATConfig;
+export interface DownloadATEvents extends IG2Events {
+}
+export interface GuardDownloadATProps extends IG2FCProps, DownloadATEvents {
+    config: Partial<DownloadATConfig>;
+}
+export interface GuardDownloadATViewProps extends GuardDownloadATProps {
+    config: DownloadATConfig;
+}

package/types/Error/index.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import './styles.less';
+export interface ErrorProps {
+    error?: Error;
+}
+export declare const GuardErrorView: React.FC<ErrorProps>;

package/types/Error/interface.d.ts

@@ -0,0 +1,8 @@
+export interface ErrorInitData {
+    error?: Error;
+}
+export interface GuardErrorProps {
+    initData?: ErrorInitData;
+}
+export interface GuardErrorViewProps extends GuardErrorProps {
+}

package/types/ForgetPassword/api/constant.d.ts

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

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

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

package/types/ForgetPassword/api/request.d.ts

@@ -0,0 +1,24 @@
+import { AxiosRequestConfig } from 'axios';
+/**
+ * 忘记密码-重置密码 邮箱
+ * @param data
+ * @param config
+ * @returns
+ */
+export declare const resetPwdEmailByAxios: (data: {
+    email: string;
+    code: string;
+    newPassword: string;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;
+/**
+ * 忘记密码-重置密码 手机号
+ * @param data
+ * @param config
+ * @returns
+ */
+export declare const restPwdPhoneByAxios: (data: {
+    phone: string;
+    code: string;
+    newPassword: string;
+    phoneCountryCode?: string;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;

package/types/ForgetPassword/core/resetPassword.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+export declare enum InputMethodMap {
+    email = "email-code",
+    phone = "phone-code"
+}
+interface ResetPasswordProps {
+    onReset: any;
+    publicConfig: any;
+    onSend: (type: 'email' | 'phone') => void;
+    onSendError: (type: 'email' | 'phone', error: any) => void;
+}
+export declare const ResetPassword: (props: ResetPasswordProps) => JSX.Element;
+export {};

package/types/ForgetPassword/index.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+/**
+ * 忘记密码
+ */
+export declare const GuardForgetPassword: React.FC;

package/types/ForgetPassword/interface.d.ts

@@ -0,0 +1,18 @@
+import { AuthenticationClient, CommonMessage } from 'authing-js-sdk';
+import { IG2Config, IG2Events, IG2FCProps, IG2FCViewProps } from '../Type';
+export interface ForgetPasswordEvents extends IG2Events {
+    onPwdEmailSend?: (authClient: AuthenticationClient) => void;
+    onPwdEmailSendError?: (error: CommonMessage, authClient: AuthenticationClient) => void;
+    onPwdPhoneSend?: (authClient: AuthenticationClient) => void;
+    onPwdPhoneSendError?: (error: CommonMessage, authClient: AuthenticationClient) => void;
+    onPwdReset?: (authClient: AuthenticationClient) => void;
+    onPwdResetError?: (error: CommonMessage, authClient: AuthenticationClient) => void;
+}
+export interface ForgetPasswordConfig extends IG2Config {
+}
+export interface ForgetPasswordProps extends IG2FCProps, ForgetPasswordEvents {
+    config: Partial<IG2Config>;
+}
+export interface ForgetPasswordViewProps extends ForgetPasswordProps, IG2FCViewProps {
+    config: IG2Config;
+}

package/types/Guard/Guard.d.ts

@@ -0,0 +1,10 @@
+import { GuardEvents } from './event';
+import { GuardAppendConfig, IG2FCProps } from '../Type';
+import { GuardLocalConfig } from './config';
+import 'moment/locale/zh-cn';
+import React from 'react';
+export interface GuardProps extends GuardEvents, IG2FCProps {
+    config?: Partial<GuardLocalConfig>;
+    appendConfig?: GuardAppendConfig;
+}
+export declare const Guard: React.MemoExoticComponent<(props: GuardProps) => JSX.Element>;

package/types/Guard/GuardModule/stateMachine.d.ts

@@ -0,0 +1,38 @@
+import { GuardLocalConfig } from '../config';
+import { GuardModuleType } from '../module';
+export interface ModuleState {
+    moduleName: GuardModuleType;
+    initData?: any;
+}
+export declare enum ActionType {
+    ChangeModule = "ChangeModule",
+    Back = "Back",
+    Init = "Init"
+}
+export interface StateMachineLog {
+    action: ActionType;
+    date: number;
+    dataSource: ModuleState;
+}
+export declare type ChangeModuleEvent = (nextModule: GuardModuleType, initData?: any) => void;
+export declare class GuardStateMachine {
+    private order;
+    private config;
+    private moduleStateHistory;
+    private changeModuleEvent;
+    private stateMachineLog;
+    constructor(changeModuleEvent: ChangeModuleEvent, initData: ModuleState);
+    uninstallPopstate: () => void;
+    globalWindow: () => Window | undefined;
+    next: (nextModule: GuardModuleType, initData: any) => void;
+    back: (initData?: any) => void;
+    end: () => void;
+    historyPush: (data: ModuleState, actionType?: ActionType) => void;
+    historyBack: (data: ModuleState) => void;
+    setConfig: (config: GuardLocalConfig) => void;
+    isUseHistoryHijack: () => boolean;
+    onPopstate: () => void;
+}
+export declare const initGuardStateMachine: (changeMouleEvent: ChangeModuleEvent, initData: ModuleState) => GuardStateMachine;
+export declare const getGuardStateMachine: () => GuardStateMachine;
+export declare const useGuardStateMachine: () => GuardStateMachine;

package/types/Guard/api/constant.d.ts

@@ -0,0 +1,2 @@
+export declare const publishConfig: (appId: string) => string;
+export declare const pageConfig: (appId: string) => string;

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

@@ -0,0 +1,13 @@
+import { AxiosRequestConfig } from 'axios';
+/**
+ * 获取应用配置信息
+ * @param appId 当前应用配置信息
+ * @returns
+ */
+export declare const getPublishConfigByAxios: <T>(appId: string, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<T>>;
+/**
+ * 获取页面配置
+ * @param appId 当前应用配置信息
+ * @returns
+ */
+export declare const getPageConfigByAxios: <T>(appId: string, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<T>>;

package/types/Guard/authClient.d.ts

@@ -0,0 +1,14 @@
+import { AuthenticationClient } from 'authing-js-sdk';
+import { GuardLocalConfig } from './config';
+declare let authClient: AuthenticationClient;
+export declare const initGuardAuthClient: (config: GuardLocalConfig, appId: string, tenantId?: string | undefined) => AuthenticationClient;
+export declare const useInitGuardAuthClient: (props: {
+    config?: GuardLocalConfig | undefined;
+    appId?: string | undefined;
+    authClient?: AuthenticationClient | undefined;
+    setError?: any;
+    tenantId?: string | undefined;
+}) => AuthenticationClient | undefined;
+export declare const getGuardAuthClient: () => AuthenticationClient;
+export declare const useGuardAuthClient: () => AuthenticationClient;
+export {};

package/types/Guard/config.d.ts

@@ -0,0 +1,27 @@
+import { ReactNode } from 'react';
+import { GuardModuleType } from '.';
+import { LoginConfig } from '../Login/interface';
+import { RegisterConfig } from '../Register/interface';
+export interface GuardComponentConfig extends Partial<GuardLocalConfig> {
+}
+export declare enum QrCodeScanType {
+    appQrcode = "appQrcode",
+    wechatMiniQrcode = "wechatMiniQrcode",
+    wechatmpQrcode = "wechatmpQrcode"
+}
+export interface QrCodeScanOptions {
+    qrcode: string;
+}
+export interface GuardLocalConfig extends RegisterConfig, LoginConfig {
+    isSSO?: boolean;
+    defaultScenes?: GuardModuleType;
+    defaultInitData?: any;
+    showLoading?: boolean;
+    loadingComponent?: ReactNode;
+    /**
+     * @description 是否调用 eventsMapping 中的事件
+     */
+    openEventsMapping?: boolean;
+    _qrCodeScanOptions?: Record<QrCodeScanType, QrCodeScanOptions>;
+}
+export declare const getDefaultGuardLocalConfig: () => GuardLocalConfig;

package/types/Guard/core/componentsMapping.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { GuardModuleType } from '../module';
+/**
+ * 组件映射表
+ * TODO: 斟酌下是否和上层 module.ts 放在一起的单个文件夹中 感觉可放可不放
+ */
+declare const ComponentsMapping: Record<GuardModuleType, (key: string) => React.ReactNode>;
+export default ComponentsMapping;