@authing/react-ui-components 4.4.0-alpha.9 → 4.4.0

package/types/Qrcode/hooks/usePostQrCode.d.ts

@@ -0,0 +1,72 @@
+/// <reference types="react" />
+import { AuthingGuardResponse, AuthingResponse } from '../../_utils/http';
+import { CodeStatus } from '../UiQrCode';
+import { CodeStatusDescriptions } from '../WorkQrCode';
+import { ReducerType, RootState } from './usePreQrCode';
+export interface QrCodeResponse {
+    /**
+     * 根据状态确定不同的流程
+     */
+    status: number;
+    /**
+     * 返回的随机值
+     */
+    random: number;
+    /**
+     * 返回的用户信息
+     */
+    userInfo?: any;
+    /**
+     * 扫码成功后 Tick 换取用户信息
+     */
+    ticket?: string;
+    /**
+     * MFA 状态下的返回
+     */
+    scannedResult?: AuthingResponse;
+}
+/**
+ * 二维码请求相关
+ */
+interface QrCodeRequest {
+    genCodeRequest?: () => Promise<AuthingGuardResponse<{
+        random: string;
+        url: string;
+    }>>;
+    /**
+     * 未扫码下的请求方法
+     */
+    readyCheckedRequest?: () => Promise<AuthingGuardResponse<QrCodeResponse>>;
+    /**
+     * 已经扫码下的请求方法（待确认）
+     */
+    alreadyCheckedRequest?: () => Promise<AuthingGuardResponse<QrCodeResponse>>;
+    /**
+     * 使用 ticket 交换用户信息
+     */
+    exchangeUserInfo?: (ticket: string) => Promise<any>;
+}
+interface QrCodeOptions {
+    state: RootState;
+    dispatch: React.Dispatch<{
+        type: ReducerType;
+        payload: Partial<RootState>;
+    }>;
+    descriptions: CodeStatusDescriptions;
+    /**
+     * check 轮询间隔时间
+     */
+    sleepTime?: number;
+    /**
+     * 状态改变时触发事件，仅在 Server 返回的二维码状态改变时进行触发
+     */
+    onStatusChange?: (status: CodeStatus, data: QrCodeResponse) => void;
+}
+/**
+ * 二维码处理阶段
+ * 二维码处理阶段分为两个主要流程
+ * 1. 同一状态下的轮询逻辑处理
+ * 2. 根据不同返回状态码进行处理
+ */
+export declare const useQrCode: (options: QrCodeOptions, request: QrCodeRequest) => void;
+export {};

package/types/Qrcode/hooks/usePreQrCode.d.ts

@@ -0,0 +1,31 @@
+/// <reference types="react" />
+import { CodeStatus } from '../UiQrCode';
+export declare type ReducerType = 'change' | 'changeStatus' | 'changeDesc';
+export declare type RootState = {
+    /**
+     * 状态
+     */
+    status: CodeStatus;
+    /**
+     * 底部描述
+     */
+    /**
+     * 当前二维码 URL
+     */
+    src?: string;
+    /**
+     * 二维码随机值
+     */
+    random?: string;
+};
+/**
+ * QrCode 准备阶段 Hook
+ */
+declare const usePreQrCode: () => {
+    state: RootState;
+    dispatch: import("react").Dispatch<{
+        type: ReducerType;
+        payload: Partial<RootState>;
+    }>;
+};
+export { usePreQrCode };

package/types/Qrcode/hooks/useStatus.d.ts

@@ -0,0 +1,7 @@
+import { CodeStatus } from '../UiQrCode';
+/**
+ * 根据不同状态添加不同的元素
+ * 维护不同状态的处理
+ */
+declare const useStatus: (status: CodeStatus) => ({} | null | undefined)[];
+export { useStatus };

package/types/Qrcode/index.d.ts

@@ -0,0 +1,7 @@
+import { UiQrCode } from './UiQrCode';
+import { WorkQrCode } from './WorkQrCode';
+declare type IQrCode = typeof WorkQrCode & {
+    UI: typeof UiQrCode;
+};
+declare const QrCode: IQrCode;
+export { QrCode };

package/types/RecoveryCode/businessRequest.d.ts

@@ -0,0 +1,5 @@
+export declare enum TotpRecoveryCodeBusinessAction {
+    RecoveryTotp = "recovery-totp",
+    ConfirmTotpRecoveryCode = "confirm-totp-recovery-code"
+}
+export declare function authFlow<T>(action: TotpRecoveryCodeBusinessAction, content: any): Promise<import("../_utils/http").AuthingGuardResponse<T>>;

package/types/RecoveryCode/core/saveCode.d.ts

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

package/types/RecoveryCode/core/useCode.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { User } from 'authing-js-sdk';
+export interface UseCodeProps {
+    mfaToken: string;
+    onSubmit: (recoveryCode: string, user?: User) => void;
+}
+export declare const UseCode: React.FC<UseCodeProps>;

package/types/RecoveryCode/index.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+import './style.less';
+export declare const RecoveryCode: React.FC;
+export declare const RecoveryCodeAuthFlow: React.FC;
+export declare const GuardRecoveryCodeView: React.FC;

package/types/RecoveryCode/interface.d.ts

@@ -0,0 +1,8 @@
+import { IG2Config, IG2Events } from '../Type';
+import { AuthenticationClient, User } from 'authing-js-sdk';
+export interface RecoveryCodeConfig extends IG2Config {
+}
+export declare const getDefaultRecoveryCodeConfig: () => RecoveryCodeConfig;
+export interface RecoveryCodeEvents extends IG2Events {
+    onLogin?: (user: User, authClient: AuthenticationClient) => void;
+}

package/types/Register/codemap.d.ts

@@ -0,0 +1,2 @@
+import { GuardModuleAction } from '../Guard/module';
+export declare const codeMap: Record<number, GuardModuleAction>;

package/types/Register/components/Agreements/index.d.ts

@@ -0,0 +1,11 @@
+import React, { FC } from 'react';
+import './style.less';
+import { Agreement } from '../../../Type/application';
+export interface AgreementsProps {
+    value?: boolean;
+    onChange?: (value: boolean) => void;
+    style?: React.CSSProperties;
+    agreements: Agreement[];
+    showError?: boolean;
+}
+export declare const Agreements: FC<AgreementsProps>;

package/types/Register/core/WithCode.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+import { Agreement, ApplicationConfig } from '../../Type/application';
+export interface RegisterWithCodeProps {
+    onRegisterSuccess: Function;
+    onRegisterFailed: Function;
+    onBeforeRegister?: Function;
+    agreements: Agreement[];
+    publicConfig?: ApplicationConfig;
+    registeContext?: any;
+    methods: any[];
+}
+/**
+ * 手机 Code 注册
+ * @param param0
+ * @returns
+ */
+export declare const RegisterWithCode: React.FC<RegisterWithCodeProps>;

package/types/Register/core/WithEmail.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import { Agreement, ApplicationConfig } from '../../Type/application';
+export interface RegisterWithEmailProps {
+    onRegisterSuccess: Function;
+    onRegisterFailed: Function;
+    onBeforeRegister?: Function;
+    publicConfig?: ApplicationConfig;
+    agreements: Agreement[];
+    registeContext?: any;
+    label?: string;
+    method?: string;
+}
+export declare const RegisterWithEmail: React.FC<RegisterWithEmailProps>;

package/types/Register/core/WithEmailCode.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { Agreement, ApplicationConfig } from '../../Type/application';
+export interface RegisterWithEmailCodeProps {
+    onRegisterSuccess: Function;
+    onRegisterFailed: Function;
+    onBeforeRegister?: Function;
+    agreements: Agreement[];
+    publicConfig?: ApplicationConfig;
+    registeContext?: any;
+}
+export declare const RegisterWithEmailCode: React.FC<RegisterWithEmailCodeProps>;

package/types/Register/core/WithPhone.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { Agreement, ApplicationConfig } from '../../Type/application';
+export interface RegisterWithPhoneProps {
+    onRegisterSuccess: Function;
+    onRegisterFailed: Function;
+    agreements: Agreement[];
+    publicConfig?: ApplicationConfig;
+    registeContext?: any;
+}
+export declare const RegisterWithPhone: React.FC<RegisterWithPhoneProps>;

package/types/Register/index.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const GuardRegisterView: React.FC;

package/types/Register/interface.d.ts

@@ -0,0 +1,25 @@
+import { AuthenticationClient, User } from 'authing-js-sdk';
+import { IG2FCProps, IG2Config, IG2Events } from '../Type';
+import { Agreement, RegisterMethods } from '../Type/application';
+export interface RegisterConfig extends IG2Config {
+    disableRegister?: boolean;
+    registerMethods?: string[];
+    defaultRegisterMethod?: string;
+    publicKey?: string;
+    agreementEnabled?: boolean;
+    agreements?: Agreement[];
+    registerContext?: any;
+}
+export interface RegisterEvents extends IG2Events {
+    onBeforeRegister?: (registerInfo: any, authClient: AuthenticationClient) => boolean | Promise<boolean>;
+    onRegister?: (user: User, authClient: AuthenticationClient) => void;
+    onRegisterError?: (error: any) => void;
+    onRegisterTabChange?: (activeTab: RegisterMethods) => void;
+}
+export interface GuardRegisterProps extends IG2FCProps, RegisterEvents {
+    config?: Partial<RegisterConfig>;
+}
+export interface GuardRegisterViewProps extends GuardRegisterProps {
+    config: RegisterConfig;
+}
+export declare const getDefaultRegisterConfig: () => RegisterConfig;

package/types/Register/utils.d.ts

@@ -0,0 +1 @@
+export declare const useIsChangeComplete: (currentMode: 'phone' | 'email') => boolean;

package/types/SelectAccount/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import './style.less';
+export declare const GuardSelectAccountView: () => JSX.Element;

package/types/SelectAccount2Login/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import './style.less';
+export declare const GuardSelectAccount2LoginView: () => JSX.Element;

package/types/SelfUnlock/core/selfUnlock.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+export declare enum InputMethodMap {
+    email = "email-code",
+    phone = "phone-code"
+}
+export declare const SelfUnlock: ({ identifyRef, }: {
+    identifyRef?: React.MutableRefObject<string> | undefined;
+}) => JSX.Element;

package/types/SelfUnlock/index.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const GuardUnlockView: React.FC;

package/types/SelfUnlock/interface.d.ts

@@ -0,0 +1,15 @@
+import { AuthenticationClient, CommonMessage } from 'authing-js-sdk';
+import { IG2Config, IG2Events, IG2FCProps } 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>;
+}

package/types/SendCode/SendCodeBtn.d.ts

@@ -0,0 +1,10 @@
+import React, { FC } from 'react';
+import './style.less';
+import { ButtonProps } from 'antd/lib/button';
+export interface SendCodeProps extends ButtonProps {
+    beforeSend: () => Promise<boolean>;
+    btnRef?: React.RefObject<HTMLButtonElement>;
+    setSent?: (value: boolean) => void;
+    sendDesc?: string;
+}
+export declare const SendCodeBtn: FC<SendCodeProps>;

package/types/SendCode/SendCodeByEmail.d.ts

@@ -0,0 +1,13 @@
+import { FC } from 'react';
+import './style.less';
+import { InputProps } from 'antd/lib/input';
+import { EmailScene } from '../Type';
+export interface SendCodeByEmailProps extends InputProps {
+    data?: string;
+    form?: any;
+    onSendCodeBefore?: any;
+    fieldName?: string;
+    autoSubmit?: boolean;
+    scene: EmailScene;
+}
+export declare const SendCodeByEmail: FC<SendCodeByEmailProps>;

package/types/SendCode/SendCodeByPhone.d.ts

@@ -0,0 +1,17 @@
+import { FC } from 'react';
+import { SceneType } from 'authing-js-sdk';
+import './style.less';
+import { InputProps } from 'antd/lib/input';
+export interface SendCodeByPhoneProps extends InputProps {
+    data?: string;
+    form?: any;
+    onSendCodeBefore?: any;
+    fieldName?: string;
+    autoSubmit?: boolean;
+    scene: SceneType;
+    areaCode?: string;
+    isInternationSms?: boolean;
+    codeFieldName?: string;
+    captchaCode?: string;
+}
+export declare const SendCodeByPhone: FC<SendCodeByPhoneProps>;

package/types/SendCode/index.d.ts

@@ -0,0 +1,9 @@
+import { FC } from 'react';
+import './style.less';
+import { InputProps } from 'antd/lib/input';
+export interface SendPhoneCodeProps extends InputProps {
+    form?: any;
+    beforeSend?: any;
+    autoSubmit?: boolean;
+}
+export declare const SendCode: FC<SendPhoneCodeProps>;

package/types/ShieldSpin/index.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+interface IG2SpinProps {
+    size?: number;
+}
+export declare const ShieldSpin: (props: IG2SpinProps) => JSX.Element;
+export declare const Spin: () => JSX.Element;
+export {};

package/types/SingleComponent/SingleComponent.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { GuardModuleType, IG2FCProps } from '..';
+export declare function SingleComponent<T extends IG2FCProps>(props: T, guardModuleType: GuardModuleType, initData?: any): JSX.Element;

package/types/SingleComponent/index.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import { GuardRegisterProps } from '../Register/interface';
+export declare const Register: React.FC<GuardRegisterProps>;

package/types/SubmitButton/index.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { ButtonProps } from 'antd/lib/button';
+interface SubmitButtonProps extends ButtonProps {
+    text?: string;
+    className?: string;
+    onClick?: any;
+    disabled?: boolean;
+}
+declare const _default: React.ForwardRefExoticComponent<SubmitButtonProps & React.RefAttributes<unknown>>;
+export default _default;

package/types/SubmitSuccess/index.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const GuardSubmitSuccessView: React.FC;

package/types/SubmitSuccess/interface.d.ts

@@ -0,0 +1,17 @@
+import { GuardModuleType } from '../Guard';
+import { IG2Config, IG2Events, IG2FCViewProps } from '../Type';
+export interface SubmitSuccessEvents extends IG2Events {
+}
+export interface SubmitSuccessConfig extends IG2Config {
+}
+export interface SubmitSuccessInitData {
+    title?: string;
+    message?: string;
+    text?: string;
+    countDesc?: string;
+    changeModule?: GuardModuleType;
+}
+export interface GuardSubmitSuccessViewProps extends IG2FCViewProps, SubmitSuccessEvents {
+    config: SubmitSuccessConfig;
+    initData?: SubmitSuccessInitData;
+}

package/types/TenantPortalSelect/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import './styles.less';
+export declare const GuardTenantPortalSelectView: () => JSX.Element;

package/types/TenantPortalSelect/interface.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="react" />
+import { AvatarProps } from 'antd/lib/avatar';
+import { AuthenticationClient, IG2Events, User } from '../Type';
+export interface TenantPortalListType {
+    tenantName: string;
+    tenantId: string;
+    tenantLogo: string;
+    host: string;
+    description: string;
+    /** 是否为用户池 */
+    isUserPool: boolean;
+    userName?: string;
+}
+export interface TenantPortalSelectType extends Omit<TenantPortalListType, 'userName'> {
+}
+/** 租户门户选择状态机返回数据类型 */
+export interface TenantPortalDataType {
+    title: string;
+    description: string;
+    logo: string;
+    list: TenantPortalListType[];
+}
+export interface TenantPortalDataItem extends TenantPortalListType {
+    avatar?: AvatarProps;
+    extra?: React.ReactNode;
+    title?: string;
+}
+/** 租户门户相关事件 */
+export interface TenantPortalEvents extends IG2Events {
+    onLogin?: (user: User, authClient: AuthenticationClient) => void;
+    /** 租户门户选择回调 */
+    onTenantSelect?: (data?: TenantPortalSelectType) => void;
+}