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

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, data: 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,8 @@
+import React from 'react';
+import './style.less';
+export declare const RecoveryCode: React.FC;
+/**
+ * authFlow 中恢复
+ */
+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/api/constant.d.ts

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

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

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

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

@@ -0,0 +1,57 @@
+import { AxiosRequestConfig } from 'axios';
+/**
+ * 邮箱验证码注册
+ * @param data
+ * @param config
+ * @returns
+ */
+export declare const registerEmailCodeByAxios: (data: {
+    email: string;
+    code: string;
+    profile: {
+        browser: string | null;
+        device: string | null | undefined;
+    };
+    context: string;
+    generateToken: boolean;
+    password?: string;
+    postUserInfoPipeline?: boolean;
+    params?: string;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;
+/**
+ * 短信验证码注册
+ * @param data
+ * @param config
+ */
+export declare const registerSmsCodeByAxios: (data: {
+    phone: string;
+    code: string;
+    phoneCountryCode?: string;
+    profile: {
+        browser: string | null;
+        device: string | null | undefined;
+    };
+    forceLogin: boolean;
+    generateToken: boolean;
+    params?: string;
+    context?: string;
+    postUserInfoPipeline?: boolean;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;
+/**
+ * 邮箱密码注册
+ * @param data
+ * @param config
+ */
+export declare const registerEmailPasswordByAxios: (data: {
+    email: string;
+    password: string;
+    profile: {
+        browser: string | null;
+        device: string | null | undefined;
+    };
+    forceLogin: boolean;
+    generateToken: boolean;
+    params?: string;
+    context?: string;
+    postUserInfoPipeline?: boolean;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../_utils/http").AuthingGuardResponse<any>>;

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,18 @@
+import React from 'react';
+import { Agreement, ApplicationConfig } from '../../Type/application';
+import { GetRegisterEvent } from '../interface';
+export interface RegisterWithCodeProps {
+    onRegisterSuccess: Function;
+    onRegisterFailed: Function;
+    onBeforeRegister?: GetRegisterEvent<'onBeforeRegister'>;
+    agreements: Agreement[];
+    publicConfig?: ApplicationConfig;
+    registeContext?: any;
+    methods: any[];
+}
+/**
+ * 验证码方式注册
+ * @param param
+ * @returns
+ */
+export declare const RegisterWithCode: React.FC<RegisterWithCodeProps>;

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

@@ -0,0 +1,17 @@
+import React from 'react';
+import { GetRegisterEvent } from '../interface';
+import { Agreement, ApplicationConfig } from '../../Type/application';
+export interface RegisterWithEmailProps {
+    onRegisterSuccess: Function;
+    onRegisterFailed: Function;
+    onBeforeRegister?: GetRegisterEvent<'onBeforeRegister'>;
+    publicConfig?: ApplicationConfig;
+    agreements: Agreement[];
+    registeContext?: any;
+}
+/**
+ * 邮箱 + 密码注册 头部显示密码注册
+ * @param param
+ * @returns
+ */
+export declare const RegisterWithEmail: React.FC<RegisterWithEmailProps>;

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,41 @@
+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?: RegisterMethods[];
+    defaultRegisterMethod?: RegisterMethods;
+    publicKey?: string;
+    agreementEnabled?: boolean;
+    agreements?: Agreement[];
+    registerContext?: any;
+}
+export declare type SupportRegisterMethods = 'email' | 'email-code' | 'phone-code';
+/**
+ * 注册前回调事件接受参数
+ */
+export interface onBeforeRegisterParams {
+    type: SupportRegisterMethods;
+    data: {
+        account: string;
+        password?: string;
+        code?: string;
+    };
+}
+/**
+ * 获取用户注册事件的类型
+ */
+export declare type GetRegisterEvent<T extends keyof RegisterEvents> = RegisterEvents[T];
+export interface RegisterEvents extends IG2Events {
+    onBeforeRegister?: (registerInfo: onBeforeRegisterParams, 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/SelfUnlock/api/index.d.ts

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

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,6 @@
+import React from 'react';
+/**
+ * 自助解锁
+ * @returns
+ */
+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,15 @@
+import { FC } from 'react';
+import './style.less';
+import { InputProps } from 'antd/lib/input';
+import { SceneType } from 'components/Type';
+export interface SendCodeByPhoneProps extends InputProps {
+    data?: string;
+    form?: any;
+    onSendCodeBefore?: any;
+    fieldName?: string;
+    autoSubmit?: boolean;
+    scene: SceneType;
+    areaCode?: string;
+    isInternationSms?: boolean;
+}
+export declare const SendCodeByPhone: FC<SendCodeByPhoneProps>;

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

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

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/Type/application.d.ts

@@ -0,0 +1,265 @@
+import { Lang } from '..';
+import { PasswordStrength } from '../_utils';
+export declare enum LoginMethods {
+    LDAP = "ldap",
+    AppQr = "app-qrcode",
+    Password = "password",
+    PhoneCode = "phone-code",
+    WxMinQr = "wechat-miniprogram-qrcode",
+    AD = "ad",
+    WechatMpQrcode = "wechatmp-qrcode"
+}
+export declare enum OIDCConnectionMode {
+    FRONT_CHANNEL = "FRONT_CHANNEL",
+    BACK_CHANNEL = "BACK_CHANNEL"
+}
+export declare enum SocialConnectionProvider {
+    ALIPAY = "alipay",
+    GOOGLE = "google",
+    WECHATPC = "wechat:pc",
+    WECHATMP = "wechat:webpage-authorization",
+    WECHAT_MINIPROGRAM = "wechat:miniprogram:default",
+    WECHAT_MINIPROGRAM_QRCODE = "wechat:miniprogram:qrconnect",
+    WECHAT_MINIPROGRAM_APPLAUNCH = "wechat:miniprogram:app-launch",
+    WECHATMOBILE = "wechat:mobile",
+    GITHUB = "github",
+    QQ = "qq",
+    WECHATWORK_ADDRESS_BOOK = "wechatwork:addressbook",
+    WECHATWORK_CORP_QRCONNECT = "wechatwork:corp:qrconnect",
+    WECHATWORK_SERVICEPROVIDER_QRCONNECT = "wechatwork:service-provider:qrconnect",
+    DINGTALK = "dingtalk",
+    WEIBO = "weibo",
+    APPLE = "apple",
+    APPLE_WEB = "apple:web",
+    LARK_PUBLIC = "lark-public",
+    LARK_INTERNAL = "lark-internal",
+    BAIDU = "baidu",
+    LINKEDIN = "linkedin",
+    SLACK = "slack",
+    YIDUN = "yidun",
+    QINGCLOUD = "qingcloud",
+    FACEBOOK = "facebook"
+}
+export declare enum Protocol {
+    AD = "ad",
+    CAS = "cas",
+    LDAP = "ldap",
+    OIDC = "oidc",
+    SAML = "saml",
+    OAUTH = "oauth",
+    AZURE_AD = "azure-ad"
+}
+export interface IOAuthConnectionConfig {
+    authEndPoint: string;
+    tokenEndPoint: string;
+    scope: string;
+    clientId: string;
+    clientSecret: string;
+    authUrlTemplate: string;
+    codeToTokenScript: string;
+    tokenToUserInfoScript: string;
+    tokenToUserInfoScriptFuncId: string;
+    codeToTokenScriptFuncId: string;
+    authUrl?: string;
+}
+export interface IAzureAdConnectionConfig {
+    microsoftAzureAdDomain: string;
+    clientId: string;
+    syncUserProfileOnLogin: string;
+    emailVerifiedDefault: boolean;
+    authorizationUrl: string;
+    callbackUrl: string;
+}
+export interface ISamlConnectionConfig {
+    signInEndPoint: string;
+    samlRequest?: string;
+    samlIdpCert: string;
+    samlSpCert: string;
+    samlSpKey: string;
+    signOutEndPoint: string;
+    signSamlRequest: boolean;
+    signatureAlgorithm: string;
+    digestAlgorithm: string;
+    protocolBinding: string;
+}
+export interface ICasConnectionConfig {
+    casConnectionLoginUrl: string;
+}
+export interface SocialConnectionItem {
+    name: string;
+    name_en: string;
+    displayName: string;
+    logo: string;
+    description: string;
+    identifier: string;
+    provider: SocialConnectionProvider;
+    authorizationUrl: string;
+    tooltip: Record<Lang, string>;
+}
+export declare enum RegisterMethods {
+    Email = "email",
+    Phone = "phone",
+    EmailCode = "emailCode"
+}
+export declare type QrcodeTabsSettings = Record<LoginMethods, Array<{
+    id: string;
+    title: string;
+    isDefault?: boolean;
+}>>;
+export interface OidcClientMetadata {
+    grant_types: string[];
+    client_id: string;
+    redirect_uris: string[];
+    scope: string;
+    response_types: ResponseType[];
+}
+export interface OIDCConnectionConfig {
+    issuerUrl: string;
+    authorizationEdpoint: string;
+    responseType: string;
+    mode: OIDCConnectionMode;
+    clientId: string;
+    clientSecret: string;
+    scopes: string;
+    redirectUri: string;
+}
+export interface InternalExtendsField {
+    type: 'internal';
+    name: string;
+    label: string;
+    inputType: string;
+    required: boolean;
+    validateRules: any[];
+}
+export interface UserExtendsField {
+    type: 'user';
+    id: string;
+    name: string;
+    label: string;
+    inputType: string;
+    required: boolean;
+    validateRules: any[];
+}
+export declare type ExtendsField = InternalExtendsField | UserExtendsField;
+export interface ApplicationPasswordTabConfig {
+    enabledLoginMethods?: PasswordLoginMethods[];
+}
+export interface ApplicationVerifyCodeTabConfig {
+    enabledLoginMethods: VerifyLoginMethods[];
+}
+export interface Agreement {
+    id: number;
+    title: string;
+    required: boolean;
+    lang: Lang;
+    availableAt?: number;
+}
+export declare type PasswordLoginMethods = 'username-password' | 'email-password' | 'phone-password';
+export declare type VerifyLoginMethods = 'email-code' | 'phone-code';
+export declare type ComplateFiledsPlace = 'register' | 'login';
+export interface ApplicationConfig {
+    id: string;
+    allowedOrigins: string[];
+    corsWhitelist: string[];
+    cdnBase: string;
+    userPoolId: string;
+    rootUserPoolId: string;
+    publicKey: string;
+    internationalSmsConfig?: {
+        enabled: boolean;
+        defaultISOType: string;
+    };
+    css: string;
+    customLoading?: string;
+    name: string;
+    logo: string;
+    description?: string;
+    redirectUris: string[];
+    registerDisabled: boolean;
+    mergeAdAndAccountPasswordLogin: boolean;
+    registerTabs: {
+        list: string[];
+        default: string;
+        title: {
+            [x: string]: string;
+        };
+    };
+    registerTabsConfig: {
+        list: string[];
+        default: string;
+        title: {
+            [x: string]: string;
+        };
+        registerTypeConfig: {
+            emailRegisterType?: RegisterMethods[];
+            phoneRegisterType?: RegisterMethods[];
+        };
+    };
+    qrcodeTabsSettings: QrcodeTabsSettings;
+    loginTabs: {
+        list: string[];
+        default: string;
+        defaultV2?: string;
+        title: {
+            [x: string]: string;
+        };
+    };
+    socialConnections: SocialConnectionItem[];
+    complateFiledsPlace: ComplateFiledsPlace[];
+    extendsFieldsEnabled: boolean;
+    extendsFields: ExtendsField[];
+    extendsFieldsI18n?: {
+        [key: string]: Record<Lang, {
+            enabled: boolean;
+            value: string;
+        }>;
+    };
+    identifier: string;
+    requestHostname: string;
+    identityProviders: {
+        identifier: string;
+        protocol: Protocol;
+        displayName: string;
+        logo: string;
+        config: ISamlConnectionConfig | OIDCConnectionConfig | ICasConnectionConfig | IAzureAdConnectionConfig | IOAuthConnectionConfig;
+    }[];
+    ssoPageComponentDisplay: {
+        autoRegisterThenLoginHintInfo: boolean;
+        forgetPasswordBtn: boolean;
+        idpBtns: boolean;
+        loginBtn: boolean;
+        loginByPhoneCodeTab: boolean;
+        loginByUserPasswordTab: boolean;
+        loginMethodNav: boolean;
+        phoneCodeInput: boolean;
+        registerBtn: boolean;
+        registerByEmailTab: boolean;
+        registerByPhoneTab: boolean;
+        registerMethodNav: boolean;
+        socialLoginBtns: boolean;
+        userPasswordInput: boolean;
+        wxMpScanTab: boolean;
+    };
+    protocol: Protocol;
+    oidcConfig: OidcClientMetadata;
+    passwordTabConfig: ApplicationPasswordTabConfig;
+    verifyCodeTabConfig?: ApplicationVerifyCodeTabConfig;
+    agreementEnabled: boolean;
+    agreements: Agreement[];
+    customPasswordStrength: any;
+    passwordStrength: PasswordStrength;
+    verifyCodeLength: number;
+    websocket: string;
+    welcomeMessage: any;
+    skipComplateFileds: boolean;
+    selfUnlockStrategy: 'captcha' | 'password-captcha';
+    defaultLanguageConfig: Lang;
+    /**
+     * 是否开启账号切换
+     */
+    enableLoginAccountSwitch: boolean;
+    /**
+     * 是否开启注册密码补全
+     */
+    enableCompletePassword: boolean;
+}