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

package/types/MFA/VerifyCodeInput/index.d.ts

@@ -0,0 +1,14 @@
+import React, { FC } from 'react';
+import './style.less';
+interface VerifyCodeInputProps extends React.HTMLAttributes<HTMLDivElement> {
+    length?: number;
+    size?: string;
+    gutter?: string;
+    onEenter?: Function;
+    showDivider?: boolean;
+    onChange?: any;
+    value?: Array<number | string>;
+    onFinish?: any;
+}
+export declare const VerifyCodeInput: FC<VerifyCodeInputProps>;
+export {};

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

@@ -0,0 +1,6 @@
+export declare const uploadFaceUrl: () => string;
+export declare const verifyEmailUrl: () => string;
+export declare const verifySmsUrl: () => string;
+export declare const verifyTotpUrl: () => string;
+export declare const verifyFaceUrl: () => string;
+export declare const faceAssociateUrl: () => string;

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

@@ -0,0 +1,2 @@
+export { sendEmailCodeByAxios } from 'service/api';
+export * from './request';

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

@@ -0,0 +1,50 @@
+import { AxiosRequestConfig } from 'axios';
+/**
+ * 上传绑定人脸识别的照片
+ */
+export declare const uploadFaceImageByAxios: <T = any>(data: FormData, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<T>>;
+/**
+ * 邮箱 mfa 认证
+ * @param data
+ * @param config
+ */
+export declare const verifyEmailMfaByAxios: (data: {
+    email: string;
+    code: string;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;
+/**
+ * 短信 mfa 认证
+ * @param data
+ * @param config
+ */
+export declare const verifySmsMfaByAxios: (data: {
+    phone: string;
+    code: string;
+    phoneCountryCode?: string;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;
+/**
+ * totp mfa 认证
+ * @param data
+ * @param config
+ */
+export declare const verifyTotpMfaByAxios: (data: {
+    totp: string;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;
+/**
+ * 人脸识别 mfa 认证
+ * @param data
+ * @param config
+ */
+export declare const verifyFaceMfaByAxios: (data: {
+    photo: string;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;
+/**
+ * 人脸对比绑定
+ * @param data
+ * @param config
+ */
+export declare const bindFaceMfaByAxios: (data: {
+    photoA: string;
+    photoB: string;
+    isExternalPhoto?: boolean;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;

package/types/MFA/businessRequest.d.ts

@@ -0,0 +1,57 @@
+export declare enum MfaBusinessAction {
+    VerifyEmail = "verify-email",
+    VerifySms = "verify-sms",
+    VerifyTotp = "verify-totp",
+    VerifyFace = "verify-face",
+    AssociateFace = "associate-face"
+}
+export declare const authFlow: (action: MfaBusinessAction, content: any) => Promise<import("../_utils/http").AuthingGuardResponse<any>>;
+interface VerifySmsContent {
+    phone: string;
+    code: string;
+    mfaToken?: string;
+    phoneCountryCode?: string;
+}
+interface VerifyEmailContent {
+    email: string;
+    code: string;
+    mfaToken?: string;
+}
+interface VerifyTotpContent {
+    totp: string;
+    mfaToken?: string;
+}
+interface VerifyFaceContent {
+    photo: string;
+    mfaToken?: string;
+}
+interface AssociateFaceContent {
+    photoA: string;
+    photoB: string;
+    isExternalPhoto?: boolean;
+    mfaToken?: string;
+}
+export declare const VerifyEmail: (content: VerifyEmailContent) => Promise<import("../_utils/http").AuthingGuardResponse<any>>;
+export declare const VerifySms: (content: VerifySmsContent) => Promise<import("../_utils/http").AuthingGuardResponse<any>>;
+export declare const VerifyTotp: (content: VerifyTotpContent) => Promise<import("../_utils/http").AuthingGuardResponse<any>>;
+export declare const VerifyFace: (content: VerifyFaceContent) => Promise<import("../_utils/http").AuthingGuardResponse<any>>;
+export declare const AssociateFace: (content: AssociateFaceContent) => Promise<import("../_utils/http").AuthingGuardResponse<any>>;
+export declare const useMfaBusinessRequest: () => {
+    "verify-email": (content: VerifyEmailContent) => Promise<import("../_utils/http").AuthingGuardResponse<any>>;
+    "verify-sms": (content: VerifySmsContent) => Promise<import("../_utils/http").AuthingGuardResponse<any>>;
+    /**
+     * Totp 状态请求
+     * @param content
+     * @returns
+     */
+    "verify-totp": (content: VerifyTotpContent) => Promise<import("../_utils/http").AuthingGuardResponse<any>>;
+    /**
+     * 人脸验证
+     */
+    "verify-face": (content: VerifyFaceContent) => Promise<import("../_utils/http").AuthingGuardResponse<any>>;
+    /**
+     * 人脸绑定
+     */
+    "associate-face": (content: AssociateFaceContent) => Promise<import("../_utils/http").AuthingGuardResponse<any>>;
+};
+export {};

package/types/MFA/codemap.d.ts

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

package/types/MFA/core/email.d.ts

@@ -0,0 +1,38 @@
+import React from 'react';
+import { MFAConfig } from '../interface';
+interface BindMFAEmailProps {
+    mfaToken: string;
+    onBind: (email: string) => void;
+    config: any;
+}
+/**
+ * 绑定邮箱页面
+ * @param param0
+ * @returns
+ */
+export declare const BindMFAEmail: React.FC<BindMFAEmailProps>;
+interface VerifyMFAEmailProps {
+    email: string;
+    mfaToken: string;
+    onVerify: (code: number, data: any) => void;
+    sendCodeRef: React.RefObject<HTMLButtonElement>;
+    codeLength: number;
+}
+/**
+ * 验证邮箱
+ * @param param0
+ * @returns
+ */
+export declare const VerifyMFAEmail: React.FC<VerifyMFAEmailProps>;
+/**
+ * 邮箱验证方式
+ * @param param0
+ * @returns
+ */
+export declare const MFAEmail: React.FC<{
+    mfaToken: string;
+    email?: string;
+    mfaLogin: any;
+    config: MFAConfig;
+}>;
+export {};

package/types/MFA/core/face.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+/**
+ * 面部认证
+ * @param props
+ * @returns
+ */
+export declare const MFAFace: (props: any) => JSX.Element;

package/types/MFA/core/face_deps.d.ts

@@ -0,0 +1,17 @@
+export declare const devicesConstraints: {
+    video: {
+        width: number;
+        height: number;
+    };
+};
+export declare const FACE_SCORE = 0.65;
+/**
+ * 人脸检测配置
+ */
+export declare function getFaceDetectorOptions(): any;
+/**
+ * 获取 facePlugin tinyFaceDetector 微型人脸探测(三种方式之一)
+ */
+export declare function getCurrentFaceDetectionNet(): any;
+export declare function isFaceDetectionModelLoaded(): boolean;
+export declare function dataURItoBlob(base64Data: any): Blob;

package/types/MFA/core/sms.d.ts

@@ -0,0 +1,38 @@
+import React from 'react';
+import { GuardMFAInitData, MFAConfig } from '../interface';
+export interface BindMFASmsProps {
+    mfaToken: string;
+    onBind: (phone: string) => void;
+    config: any;
+    areaCode: string;
+    setAreaCode: (areaCode: string) => void;
+    isInternationSms: boolean;
+}
+/**
+ * 绑定手机号
+ * @param param0
+ * @returns
+ */
+export declare const BindMFASms: React.FC<BindMFASmsProps>;
+export interface VerifyMFASmsProps {
+    mfaToken: string;
+    phone: string;
+    onVerify: (code: number, data: any) => void;
+    sendCodeRef: React.RefObject<HTMLButtonElement>;
+    codeLength: number;
+    areaCode: string;
+    phoneCountryCode?: string;
+    isInternationSms: boolean;
+    userPhone?: string;
+}
+export declare const VerifyMFASms: React.FC<VerifyMFASmsProps>;
+/**
+ * 手机 MFA
+ * @param param0
+ * @returns
+ */
+export declare const MFASms: React.FC<{
+    mfaLogin: any;
+    config: MFAConfig;
+    initData: GuardMFAInitData;
+}>;

package/types/MFA/core/totp.d.ts

@@ -0,0 +1,37 @@
+import React from 'react';
+import { GuardMFAInitData, MFAConfig } from '../interface';
+export interface BindMFATotpProps {
+    initData: GuardMFAInitData;
+    changeModule: any;
+}
+/**
+ * 绑定 ToTp 页面 跳转 Totp
+ * @param param0
+ * @returns
+ */
+export declare const BindMFATotp: React.FC<BindMFATotpProps>;
+export interface VerifyMFATotpProps {
+    mfaToken: string;
+    mfaLogin: any;
+    changeModule: any;
+}
+/**
+ * Totp 验证页面
+ * @param param0
+ * @returns
+ */
+export declare const VerifyMFATotp: React.FC<VerifyMFATotpProps>;
+export interface MFATotpProps {
+    changeModule: any;
+    config: MFAConfig;
+    initData: GuardMFAInitData;
+    mfaLogin: any;
+}
+/**
+ * MFA Totp 页面
+ * 开启 => 渲染 VerifyMFATotp 绑定
+ * 不开启 => 渲染绑定页面
+ * @param param
+ * @returns
+ */
+export declare const MFATotp: React.FC<MFATotpProps>;

package/types/MFA/index.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import './styles.less';
+interface MFABackStateContextType {
+    setMfaBackState: React.Dispatch<React.SetStateAction<string>>;
+    mfaBackState: string;
+}
+export declare const MFABackStateContext: React.Context<MFABackStateContextType | undefined>;
+/**
+ * MFA 相关页面
+ * @returns
+ */
+export declare const GuardMFAView: React.FC;
+export {};

package/types/MFA/interface.d.ts

@@ -0,0 +1,40 @@
+import { IG2Config, IG2Events, IG2FCProps } from '../Type';
+import { AuthenticationClient, User } from 'authing-js-sdk';
+export interface MFAConfig extends IG2Config {
+    autoRegister: boolean;
+}
+export declare const getDefaultMFAConfig: () => MFAConfig;
+export interface MFAEvents extends IG2Events {
+    onLogin?: (user: User, authClient: AuthenticationClient) => void;
+}
+export declare enum MFAType {
+    SMS = "SMS",
+    EMAIL = "EMAIL",
+    TOTP = "OTP",
+    FACE = "FACE"
+}
+export interface GuardMFAInitData {
+    mfaToken: string;
+    applicationMfa: {
+        mfaPolicy: MFAType;
+        sort: number;
+        status: 0 | 1;
+    }[];
+    phoneCountryCode?: string;
+    faceMfaEnabled: boolean;
+    totpMfaEnabled: boolean;
+    email?: string;
+    phone?: string;
+    avatar?: string;
+    nickme?: string;
+    username?: string;
+    current?: MFAType;
+}
+export interface GuardMFAProps extends IG2FCProps, MFAEvents {
+    config: Partial<MFAConfig>;
+    initData: GuardMFAInitData;
+}
+export interface GuardMFAViewProps extends GuardMFAProps {
+    config: MFAConfig;
+    initData: GuardMFAInitData;
+}

package/types/MFA/mfaMethods/index.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { MFAType } from '../interface';
+import './style.less';
+export interface MFAMethodsProps {
+    method: MFAType;
+    onChangeMethod: (type: MFAType) => void;
+}
+export declare const MFAMethods: React.FC<MFAMethodsProps>;

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

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

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * 问题反馈
+ * @param data
+ * @returns
+ */
+export declare const feedbackByAxios: (data: {
+    type: number;
+    description: string;
+    phone: string;
+    images: string[];
+    appId: string;
+}) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;

package/types/NeedHelpView/core/describeQuestions.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+interface describeQuestionsProps {
+    appId: string;
+    host: string;
+    onSuccess: any;
+}
+export declare const DescribeQuestions: (props: describeQuestionsProps) => JSX.Element;
+export {};

package/types/NeedHelpView/index.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const GuardNeedHelpView: (props: any) => JSX.Element;

package/types/Qrcode/UiQrCode.d.ts

@@ -0,0 +1,51 @@
+import React from 'react';
+import './index.less';
+import { CodeStatusDescriptions } from './WorkQrCode';
+export declare type CodeStatus = 'loading' | 'ready' | 'already' | 'success' | 'error' | 'expired' | 'cancel' | 'MFA';
+export declare const prefix = "refactor";
+export interface UiQrProps {
+    /**
+     * Loading 组件
+     */
+    loadingComponent?: React.ReactElement;
+    /**
+     * 二维码组件三种状态
+     * ready 准备状态
+     * already 已扫描状态
+     * success 扫描成功/登录成功状态
+     * error 错误状态（超时、网络错误）
+     */
+    status: CodeStatus;
+    /**
+     * 二维码 URL
+     */
+    src?: string;
+    /**
+     * 二维码底部内容
+     */
+    descriptions: CodeStatusDescriptions;
+    /**
+     * 外层 container 样式
+     */
+    containerStyle?: React.CSSProperties;
+    /**
+     * 内层 container 样式(图片)
+     */
+    imageStyle?: React.CSSProperties;
+    /**
+     * 二维码图片准备好的回调
+     */
+    onLoad?: () => void;
+    /**
+     * 点击遮罩中的内容区
+     * status 当前组件所处状态
+     */
+    onClickMaskEl?: (status: CodeStatus) => void;
+    /**
+     * 点击全部遮罩区域
+     * status 当前组件所处状态
+     */
+    onMaskContent?: (status: CodeStatus) => void;
+}
+declare const UiQrCode: React.NamedExoticComponent<UiQrProps>;
+export { UiQrCode };

package/types/Qrcode/WorkQrCode.d.ts

@@ -0,0 +1,41 @@
+import React from 'react';
+import { QrCodeResponse } from './hooks/usePostQrCode';
+import { CodeStatus, UiQrProps } from './UiQrCode';
+/**
+ * 二维码不同状态下的底部描述文字
+ */
+export declare type CodeStatusDescriptions = Partial<Record<Exclude<CodeStatus, 'loading'>, React.ReactNode | ((referQrCode?: () => void) => React.ReactNode)>>;
+export interface WorkQrCodeRef {
+    referQrCode: () => Promise<{
+        random: string;
+        url: string;
+    } | undefined>;
+}
+export interface WorkQrCodeProps extends Omit<UiQrProps, 'description' | 'status'> {
+    /**
+     * 二维码场景
+     */
+    scene: 'WXAPP_AUTH' | 'APP_AUTH' | 'WECHATMP_AUTH';
+    /**
+     * 不同状态请求文字
+     */
+    descriptions: CodeStatusDescriptions;
+    /**
+     * 睡眠时间 默认 1000
+     */
+    sleepTime?: number;
+    /**
+     * 每当状态变化时，触发的 callback 。
+     */
+    onStatusChange?: (status: CodeStatus, data: QrCodeResponse) => void;
+    /**
+     * 不同状态下点击遮罩中间区域方法
+     */
+    onClickMaskContent?: (status: CodeStatus) => void;
+    /**
+     * 不同二维码下生成配置
+     */
+    qrCodeScanOptions?: any;
+}
+declare const WorkQrCode: React.ForwardRefExoticComponent<WorkQrCodeProps & React.RefAttributes<any>>;
+export { WorkQrCode };

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

@@ -0,0 +1,3 @@
+export declare const qrcodeCheckUrl: (random: string) => string;
+export declare const exChangeUserInfoUrl: () => string;
+export declare const geneQrcodeUrl: () => string;

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

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

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

@@ -0,0 +1,44 @@
+import { AxiosRequestConfig } from 'axios';
+import { WorkQrCodeProps } from '../WorkQrCode';
+/**
+ * 二维码状态check
+ * @param ticket
+ * @param config
+ */
+export declare const qrcodeStatusCheckByAxios: (ticket: string) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;
+/**
+ * ticket 换用户信息
+ * @param data
+ * @param config
+ */
+export declare const exChangeUserInfoByAxios: (data: {
+    ticket: string;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;
+/**
+ * 二维码生成
+ * @param data
+ * @param config
+ */
+export declare const geneQrcodeByAxios: <T = {
+    random: string;
+    url: string;
+}>(data: {
+    autoMergeQrCode: boolean;
+    scene: WorkQrCodeProps['scene'];
+    /**
+     * 请求上下文，将会传递到 Pipeline 中
+     */
+    context: any;
+    /**
+     * 是否获取用户自定义数据
+     */
+    params: any;
+    /**
+     * 是否获取用户自定义数据
+     */
+    withCustomData: any;
+    /**
+     * 多租户用的额外的 Idp Id。
+     */
+    extIdpConnId: string;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<T>>;

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

@@ -0,0 +1,4 @@
+declare const useImage: (src: string | undefined, options: {
+    onLoad?: (() => void) | undefined;
+}) => (string | undefined)[];
+export { useImage };

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

@@ -0,0 +1,69 @@
+/// <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;
+    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/api/constant.d.ts

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

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

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

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

@@ -0,0 +1,10 @@
+import { AxiosRequestConfig } from 'axios';
+/**
+ * 不在流程中（AuthFlow）请求恢复 Totp 请求
+ * @param data
+ * @param config
+ * @returns
+ */
+export declare const recoverCodeByAxios: (data: {
+    recoveryCode: string;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;