@authing/react-ui-components 3.1.15-rc.2 → 3.1.15

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Authing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/index.d.ts

@@ -381,7 +381,6 @@ declare module '@authing/react-ui-components/components/AuthingGuard/api/appConf
   import { Lang, LoginMethods, Protocol } from '@authing/react-ui-components/components/AuthingGuard/types/index';
   import { IAzureAdConnectionConfig, ICasConnectionConfig, IOAuthConnectionConfig, ISamlConnectionConfig, OIDCConnectionConfig, SocialConnectionItem } from '@authing/react-ui-components/components/AuthingGuard/api/userPoolConfig';
   import { PasswordStrength } from '@authing/react-ui-components/components/_utils/index';
-  import { NewRegisterMethods } from '@authing/react-ui-components/components/Type/index';
   export enum ApplicationMfaType {
       SMS = "SMS",
       EMAIL = "EMAIL"
@@ -458,17 +457,6 @@ declare module '@authing/react-ui-components/components/AuthingGuard/api/appConf
               [x: string]: string;
           };
       };
-      registerTabsConfig: {
-          list: string[];
-          default: string;
-          title: {
-              [x: string]: string;
-          };
-          registerTypeConfig: {
-              emailRegisterType?: NewRegisterMethods[];
-              phoneRegisterType?: NewRegisterMethods[];
-          };
-      };
       qrcodeTabsSettings: QrcodeTabsSettings;
       loginTabs: {
           list: string[];
@@ -1205,15 +1193,14 @@ declare module '@authing/react-ui-components/components/ChangePassword/index' {
 
 }
 declare module '@authing/react-ui-components/components/CompleteInfo/businessRequest' {
-  import { User } from 'authing-js-sdk';
-  import { CompleteInfoRequest, RegisterCompleteInfoInitData } from '@authing/react-ui-components/components/CompleteInfo/interface';
+  import { CompleteInfoRequest } from '@authing/react-ui-components/components/CompleteInfo/interface';
   export enum CompleteInfoAuthFlowAction {
       Complete = "complete-completion",
       Skip = "skip-completion"
   }
   export const authFlow: (action: CompleteInfoAuthFlowAction, data?: CompleteInfoRequest | undefined) => Promise<import("@authing/react-ui-components/components/_utils/http").AuthingGuardResponse<any>>;
-  export const registerSkipMethod: (fnName: RegisterCompleteInfoInitData['businessRequestName'], content: any) => Promise<import("@authing/react-ui-components/components/_utils/http").AuthingGuardResponse<any>> | Promise<User> | undefined;
-  export const registerRequest: (action: CompleteInfoAuthFlowAction, registerFnName: RegisterCompleteInfoInitData['businessRequestName'], registerContent: any, registerProfile?: any) => Promise<User | import("@authing/react-ui-components/components/_utils/http").AuthingGuardResponse<any> | undefined>;
+  export const registerSkipMethod: (fnName: 'registerByEmail' | 'registerByPhoneCode', content: any) => Promise<import("authing-js-sdk").User> | undefined;
+  export const registerRequest: (action: CompleteInfoAuthFlowAction, registerFnName: 'registerByEmail' | 'registerByPhoneCode', registerContent: any, registerProfile?: any) => Promise<import("authing-js-sdk").User | undefined>;
 
 }
 declare module '@authing/react-ui-components/components/CompleteInfo/core/completeInfo' {
@@ -1325,7 +1312,7 @@ declare module '@authing/react-ui-components/components/CompleteInfo/interface'
   }
   export interface RegisterCompleteInfoInitData {
       content: any;
-      businessRequestName: 'registerByEmail' | 'registerByPhoneCode' | 'registerByEmailCode';
+      businessRequestName: 'registerByEmail' | 'registerByPhoneCode';
   }
   export interface CompleteInfoRequest {
       fieldValues: {
@@ -1336,8 +1323,7 @@ declare module '@authing/react-ui-components/components/CompleteInfo/interface'
   }
   export enum OmitCompleteInfo {
       'registerByEmail' = "email",
-      'registerByPhoneCode' = "phone",
-      'registerByEmailCode' = "email"
+      'registerByPhoneCode' = "phone"
   }
 
 }
@@ -1503,19 +1489,21 @@ declare module '@authing/react-ui-components/components/Guard/GuardModule/stateM
 declare module '@authing/react-ui-components/components/Guard/authClient' {
   import { AuthenticationClient } from 'authing-js-sdk';
   import { GuardLocalConfig } from '@authing/react-ui-components/components/Guard/config';
+  let authClient: AuthenticationClient;
   export const initGuardAuthClient: (config: GuardLocalConfig, appId: string, tenantId?: string | undefined) => AuthenticationClient;
   export const useInitGuardAuthClient: (props: {
       config?: GuardLocalConfig | undefined;
-      appId: string;
+      appId?: string | undefined;
+      authClient?: AuthenticationClient | undefined;
       setError?: any;
       tenantId?: string | undefined;
   }) => AuthenticationClient | undefined;
   export const getGuardAuthClient: () => AuthenticationClient;
   export const useGuardAuthClient: () => AuthenticationClient;
+  export {};
 
 }
 declare module '@authing/react-ui-components/components/Guard/config' {
-  import { AuthenticationClient } from 'authing-js-sdk';
   import { ReactNode } from 'react';
   import { GuardModuleType } from '@authing/react-ui-components/components/Guard/index';
   import { LoginConfig } from '@authing/react-ui-components/components/Login/interface';
@@ -1541,7 +1529,6 @@ declare module '@authing/react-ui-components/components/Guard/config' {
        */
       openEventsMapping?: boolean;
       _qrCodeScanOptions?: Record<QrCodeScanType, QrCodeScanOptions>;
-      authClient?: AuthenticationClient;
   }
   export const getDefaultGuardLocalConfig: () => GuardLocalConfig;
 
@@ -1564,7 +1551,6 @@ declare module '@authing/react-ui-components/components/Guard/core/renderContext
   export const RenderContext: React.FC<{
       guardProps: GuardProps;
       initState: ModuleState;
-      forceUpdate: number;
   }>;
 
 }
@@ -1582,10 +1568,10 @@ declare module '@authing/react-ui-components/components/Guard/core/renderModule'
 
 }
 declare module '@authing/react-ui-components/components/Guard/core/useAppendConfig' {
-  import { GuardProps } from '@authing/react-ui-components/components/index';
+  import { GuardAppendConfig } from '@authing/react-ui-components/components/index';
   export const getGuardWindow: () => (Window & typeof globalThis) | undefined;
   export const useGuardWindow: () => (Window & typeof globalThis) | undefined;
-  export const useInitGuardAppendConfig: (guardProps: GuardProps, setForceUpdate: any) => void;
+  export const useInitGuardAppendConfig: (appId?: string | undefined, appendConfig?: GuardAppendConfig | undefined) => void;
 
 }
 declare module '@authing/react-ui-components/components/Guard/core/usePlugin' {
@@ -1607,6 +1593,50 @@ declare module '@authing/react-ui-components/components/Guard/event' {
   }
   export const guardEventsFilter: (props: any, openEventsMapping?: boolean | undefined) => GuardEvents;
   export const guardEventsHijacking: (events: GuardEvents, openEventsMapping?: boolean | undefined) => GuardEvents;
+  export const GuardEventsCamelToKebabMapping: {
+      readonly onLoad: "load";
+      readonly onLoadError: "load-error";
+      readonly onLogin: "login";
+      readonly onBeforeLogin: "before-login";
+      readonly onLoginError: "login-error";
+      readonly onRegister: "register";
+      readonly onBeforeRegister: "before-register";
+      readonly onRegisterError: "register-error";
+      readonly onPwdEmailSend: "pwd-email-send";
+      readonly onPwdEmailSendError: "pwd-email-send-error";
+      readonly onPwdPhoneSend: "pwd-phone-send";
+      readonly onPwdPhoneSendError: "pwd-phone-send-error";
+      readonly onPwdReset: "pwd-reset";
+      readonly onPwdResetError: "pwd-reset-error";
+      readonly onClose: "close";
+      readonly onLoginTabChange: "login-tab-change";
+      readonly onRegisterTabChange: "register-tab-change";
+      readonly onRegisterInfoCompleted: "register-info-completed";
+      readonly onRegisterInfoCompletedError: "register-info-completed-error";
+      readonly onLangChange: "lang-change";
+  };
+  export interface GuardEventsKebabToCamelType {
+      load: GuardEvents['onLoad'];
+      'load-error': GuardEvents['onLoadError'];
+      'before-login': GuardEvents['onBeforeLogin'];
+      login: GuardEvents['onLogin'];
+      'login-error': GuardEvents['onLoginError'];
+      'before-register': GuardEvents['onBeforeRegister'];
+      register: GuardEvents['onRegister'];
+      'register-error': GuardEvents['onRegisterError'];
+      'pwd-email-send': GuardEvents['onPwdEmailSend'];
+      'pwd-email-send-error': GuardEvents['onPwdEmailSendError'];
+      'pwd-phone-send': GuardEvents['onPwdPhoneSend'];
+      'pwd-phone-send-error': GuardEvents['onPwdPhoneSendError'];
+      'pwd-reset': GuardEvents['onPwdReset'];
+      'pwd-reset-error': GuardEvents['onPwdResetError'];
+      close: GuardEvents['onClose'];
+      'login-tab-change': GuardEvents['onLoginTabChange'];
+      'register-tab-change': GuardEvents['onRegisterTabChange'];
+      'register-info-completed': GuardEvents['onRegisterInfoCompleted'];
+      'register-info-completed-error': GuardEvents['onRegisterInfoCompletedError'];
+      'lang-change': GuardEvents['onLangChange'];
+  }
 
 }
 declare module '@authing/react-ui-components/components/Guard/index' {
@@ -2406,20 +2436,6 @@ declare module '@authing/react-ui-components/components/Register/core/WithEmail'
   }
   export const RegisterWithEmail: React.FC<RegisterWithEmailProps>;
 
-}
-declare module '@authing/react-ui-components/components/Register/core/WithEmailCode' {
-  import React from 'react';
-  import { Agreement, ApplicationConfig } from '@authing/react-ui-components/components/AuthingGuard/api/index';
-  export interface RegisterWithEmailCodeProps {
-      onRegisterSuccess: Function;
-      onRegisterFailed: Function;
-      onBeforeRegister?: Function;
-      agreements: Agreement[];
-      publicConfig?: ApplicationConfig;
-      registeContext?: any;
-  }
-  export const RegisterWithEmailCode: React.FC<RegisterWithEmailCodeProps>;
-
 }
 declare module '@authing/react-ui-components/components/Register/core/WithPhone' {
   import React from 'react';
@@ -2440,13 +2456,14 @@ declare module '@authing/react-ui-components/components/Register/index' {
 
 }
 declare module '@authing/react-ui-components/components/Register/interface' {
-  import { IG2FCProps, IG2Config, IG2Events, NewRegisterMethods } from '@authing/react-ui-components/components/Type/index';
+  import { RegisterMethods } from 'authing-js-sdk';
+  import { IG2FCProps, IG2Config, IG2Events } from '@authing/react-ui-components/components/Type/index';
   import { AuthenticationClient, User, EmailRegisterParams, PhoneRegisterParams } from '@authing/react-ui-components/components/index';
   import { Agreement } from '@authing/react-ui-components/components/AuthingGuard/api/index';
   export interface RegisterConfig extends IG2Config {
       disableRegister?: boolean;
-      registerMethods?: NewRegisterMethods[];
-      defaultRegisterMethod?: NewRegisterMethods;
+      registerMethods?: RegisterMethods[];
+      defaultRegisterMethod?: RegisterMethods;
       publicKey?: string;
       agreementEnabled?: boolean;
       agreements?: Agreement[];
@@ -2456,7 +2473,7 @@ declare module '@authing/react-ui-components/components/Register/interface' {
       onBeforeRegister?: (registerInfo: EmailRegisterParams | PhoneRegisterParams, authClient: AuthenticationClient) => boolean | Promise<boolean>;
       onRegister?: (user: User, authClient: AuthenticationClient) => void;
       onRegisterError?: (error: any) => void;
-      onRegisterTabChange?: (activeTab: NewRegisterMethods) => void;
+      onRegisterTabChange?: (activeTab: RegisterMethods) => void;
   }
   export interface GuardRegisterProps extends IG2FCProps, RegisterEvents {
       config?: Partial<RegisterConfig>;
@@ -2486,11 +2503,11 @@ declare module '@authing/react-ui-components/components/SendCode/SendCodeBtn' {
 }
 declare module '@authing/react-ui-components/components/SendCode/SendCodeByEmail' {
   import { FC } from 'react';
+  import { EmailScene } from 'authing-js-sdk';
   import './style.less';
   import { InputProps } from 'antd/lib/input';
-  import { EmailScene } from '@authing/react-ui-components/components/Type/index';
   export interface SendCodeByEmailProps extends InputProps {
-      data?: string;
+      data: string;
       form?: any;
       onSendCodeBefore?: any;
       fieldName?: string;
@@ -2558,7 +2575,6 @@ declare module '@authing/react-ui-components/components/SubmitButton/index' {
       text?: string;
       className?: string;
       onClick?: any;
-      disabled?: boolean;
   }
   const _default: React.ForwardRefExoticComponent<SubmitButtonProps & React.RefAttributes<unknown>>;
   export default _default;
@@ -2597,13 +2613,14 @@ declare module '@authing/react-ui-components/components/Type/index' {
   import { GuardModuleType } from '@authing/react-ui-components/components/Guard/module';
   import { FacePlugin } from '@authing/react-ui-components/components/_utils/facePlugin/interface';
   export interface IG2FCProps extends IG2Events {
-      appId: string;
+      appId?: string;
       tenantId?: string;
       config?: Partial<IG2Config>;
       visible?: boolean;
       initData?: any;
       appendConfig?: GuardAppendConfig;
       facePlugin?: FacePlugin;
+      authClient?: AuthenticationClient;
   }
   export interface GuardAppendConfig {
       internalRequest?: boolean;
@@ -2653,24 +2670,6 @@ declare module '@authing/react-ui-components/components/Type/index' {
           showChangeLanguage: boolean;
       };
   }
-  export enum NewRegisterMethods {
-      Email = "email",
-      Phone = "phone",
-      EmailCode = "emailCode"
-  }
-  export 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"
-  }
 
 }
 declare module '@authing/react-ui-components/components/ValidatorRules/PasswordFormItem' {
@@ -2765,15 +2764,15 @@ declare module '@authing/react-ui-components/components/_utils/clipboard' {
 }
 declare module '@authing/react-ui-components/components/_utils/config/index' {
   /// <reference types="react" />
+  import { RegisterMethods } from 'authing-js-sdk';
   import { ApplicationConfig } from '@authing/react-ui-components/components/AuthingGuard/api/index';
   import { GuardComponentConfig, GuardLocalConfig } from '@authing/react-ui-components/components/Guard/config';
   import { GuardHttp } from '@authing/react-ui-components/components/_utils/guardHttp';
-  import { NewRegisterMethods } from '@authing/react-ui-components/components/Type/index';
   import { GuardPageConfig } from '@authing/react-ui-components/components/Type/index';
   export const getPublicConfig: (appId: string) => ApplicationConfig;
   export const setPublicConfig: (appId: string, config: ApplicationConfig) => ApplicationConfig;
   export const useMergeDefaultConfig: (defaultConfig: GuardLocalConfig, config?: GuardComponentConfig | undefined) => GuardLocalConfig | undefined;
-  export const useMergePublicConfig: (appId: string, forceUpdate: number, config?: GuardLocalConfig | undefined, httpClient?: GuardHttp | undefined, serError?: any) => {
+  export const useMergePublicConfig: (appId?: string | undefined, config?: GuardLocalConfig | undefined, httpClient?: GuardHttp | undefined, setError?: any) => {
       host: string;
       isSSO?: boolean | undefined;
       defaultScenes?: import("@authing/react-ui-components/components/index").GuardModuleType | undefined;
@@ -2782,10 +2781,9 @@ declare module '@authing/react-ui-components/components/_utils/config/index' {
       loadingComponent?: import("react").ReactNode;
       openEventsMapping?: boolean | undefined;
       _qrCodeScanOptions?: Record<import("@authing/react-ui-components/components/Guard/config").QrCodeScanType, import("../../Guard/config").QrCodeScanOptions> | undefined;
-      authClient?: import("authing-js-sdk").AuthenticationClient | undefined;
       disableRegister?: boolean | undefined;
-      registerMethods?: NewRegisterMethods[] | undefined;
-      defaultRegisterMethod?: NewRegisterMethods | undefined;
+      registerMethods?: RegisterMethods[] | undefined;
+      defaultRegisterMethod?: RegisterMethods | undefined;
       publicKey?: string | undefined;
       agreementEnabled?: boolean | undefined;
       agreements?: import("@authing/react-ui-components/components/AuthingGuard/api/index").Agreement[] | undefined;
@@ -2813,6 +2811,7 @@ declare module '@authing/react-ui-components/components/_utils/config/index' {
       socialConnectionsBtnShape?: "default" | "button" | "icon" | undefined;
       enterpriseConnections?: string[] | undefined;
       qrCodeScanOptions?: {
+          currentDocument?: Document | undefined;
           extIdpConnId?: string | undefined;
           autoExchangeUserInfo?: boolean | undefined;
           size?: {
@@ -2859,7 +2858,7 @@ declare module '@authing/react-ui-components/components/_utils/config/index' {
   export const getPageConfig: (appId: string) => GuardPageConfig;
   export const setPageConfig: (appId: string, config: GuardPageConfig) => GuardPageConfig;
   export const requestGuardPageConfig: (appId: string, httpClient: GuardHttp) => Promise<GuardPageConfig>;
-  export const useGuardPageConfig: (appId: string, forceUpdate: number, httpClient?: GuardHttp | undefined, serError?: any) => GuardPageConfig | undefined;
+  export const useGuardPageConfig: (appId?: string | undefined, httpClient?: GuardHttp | undefined, serError?: any) => GuardPageConfig | undefined;
 
 }
 declare module '@authing/react-ui-components/components/_utils/context' {
@@ -3070,10 +3069,9 @@ declare module '@authing/react-ui-components/components/_utils/http' {
 declare module '@authing/react-ui-components/components/_utils/index' {
   import { Rule } from 'antd/lib/form';
   import qs from 'qs';
-  import { User } from 'authing-js-sdk';
+  import { RegisterMethods, User } from 'authing-js-sdk';
   import { ApplicationConfig, ComplateFiledsPlace } from '@authing/react-ui-components/components/AuthingGuard/api/index';
   import { GuardProps } from '@authing/react-ui-components/components/Guard/index';
-  import { NewRegisterMethods } from '@authing/react-ui-components/components/Type/index';
   export * from '@authing/react-ui-components/components/_utils/popupCenter';
   export * from '@authing/react-ui-components/components/_utils/clipboard';
   export const VALIDATE_PATTERN: {
@@ -3134,13 +3132,23 @@ declare module '@authing/react-ui-components/components/_utils/index' {
   export const getPasswordValidate: (strength?: PasswordStrength, customPasswordStrength?: any, fieldRequiredRuleMessage?: string | undefined) => Rule[];
   export const sleep: (delay: number) => Promise<unknown>;
   export const shoudGoToComplete: (user: User, contextType: ComplateFiledsPlace, config: ApplicationConfig | undefined, autoRegister?: boolean | undefined) => boolean;
-  export const tabSort: (defaultValue: NewRegisterMethods, tabList: NewRegisterMethods[]) => NewRegisterMethods[];
+  export const tabSort: (defaultValue: RegisterMethods, tabList: RegisterMethods[]) => RegisterMethods[];
   export const mailDesensitization: (mail: string) => string;
   export const phoneDesensitization: (phone: string) => string;
   export const getHundreds: (num: number) => number;
   export const GuardPropsFilter: (pre: GuardProps, current: GuardProps) => boolean;
   export const getDocumentNode: (node: Node & ParentNode) => Document;
 
+}
+declare module '@authing/react-ui-components/components/_utils/initAppId' {
+  import { AuthenticationClient } from 'authing-js-sdk';
+  export interface UseInitAppidProps {
+      propsAppid?: string;
+      propsAuthClient?: AuthenticationClient;
+      setError?: any;
+  }
+  export const useInitAppId: (propsAppid?: string | undefined, propsAuthClient?: AuthenticationClient | undefined, setError?: any) => string | undefined;
+
 }
 declare module '@authing/react-ui-components/components/_utils/locales/en/index' {
   import common from '@authing/react-ui-components/components/_utils/locales/en/common/index';
@@ -3323,7 +3331,7 @@ declare module '@authing/react-ui-components/components/version/index' {
 
 }
 declare module '@authing/react-ui-components/components/version/version' {
-  const _default: "3.1.15-rc.2";
+  const _default: "3.1.15";
   export default _default;
 
 }