@authing/react18-ui-components 4.4.0-alpha.8 → 4.4.0

package/types/Type/application.d.ts

@@ -0,0 +1,337 @@
+import { Lang } from '..';
+import { PasswordStrength } from '../_utils';
+export * from 'authing-js-sdk';
+export declare enum LoginMethods {
+    LDAP = "ldap",
+    AppQr = "app-qrcode",
+    Password = "password",
+    PhoneCode = "phone-code",
+    WxMinQr = "wechat-miniprogram-qrcode",
+    AD = "ad",
+    WechatMpQrcode = "wechatmp-qrcode",
+    AuthingOtpPush = "authing-otp-push"
+}
+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",
+    AD_KERBEROS = "ad-kerberos"
+}
+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 enum RegisterSortMethods {
+    Email = "email-password",
+    Phone = "phone-code",
+    EmailCode = "email-code"
+}
+export interface QrCodeItem {
+    id: string;
+    title: string;
+    isDefault?: boolean;
+}
+export type QrcodeTabsSettings = Record<LoginMethods, Array<QrCodeItem>>;
+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 type ExtendsField = InternalExtendsField | UserExtendsField;
+export interface ApplicationPasswordTabConfig {
+    enabledLoginMethods?: PasswordLoginMethods[];
+    validRegisterMethods?: string[];
+    validLoginMethods?: string[];
+}
+export interface ApplicationVerifyCodeTabConfig {
+    enabledLoginMethods: VerifyLoginMethods[];
+    validRegisterMethods?: string[];
+    validLoginMethods?: string[];
+}
+export interface Agreement {
+    id: number;
+    title: string;
+    required: boolean;
+    lang: Lang;
+    availableAt?: number;
+}
+export type PasswordLoginMethods = 'username-password' | 'email-password' | 'phone-password';
+export type VerifyLoginMethods = 'email-code' | 'phone-code';
+export type ComplateFiledsPlace = 'register' | 'login';
+export interface TabFieldsI18nItem {
+    key: string;
+    label: string;
+    labelEn: string;
+    i18n: {
+        [propName in Lang]?: string;
+    };
+}
+interface LoginTypeI18nProps {
+    tab: {
+        default: string;
+        i18n: {
+            [propName: string]: string;
+        };
+    };
+}
+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;
+    deviceFuncEnabled?: boolean;
+    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;
+    qrCodeSortConfig: {
+        loginMethodsSort?: string[];
+    };
+    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;
+        loginMethodsI18nDisplaySettings: {
+            password?: LoginTypeI18nProps;
+            verifyCode?: LoginTypeI18nProps;
+            ad?: LoginTypeI18nProps;
+            ldap?: LoginTypeI18nProps;
+        };
+    };
+    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;
+    /**
+     * 登录注册排序
+     */
+    tabMethodsSortConfig: {
+        loginMethodsSort: string[];
+    };
+    tabMethodsFields: TabFieldsI18nItem[];
+    regexRules?: {
+        key: string;
+        appLevel: string;
+        userpoolLevel: string;
+    }[];
+    /** 是否为租户控制台应用 */
+    isTenantConsole?: boolean;
+    /** 是否默认为租户应用面板应用 */
+    isTenantDefault?: boolean;
+    /** 租户详情 */
+    tenantInfo?: Record<string, any>;
+    /** mfa 相关 */
+    mfa: {
+        faceScore: number;
+    };
+    authingOtpPushTabConfig: {
+        enabledLoginMethods: Array<string> | null;
+        validLoginMethods: Array<string> | null;
+        validRegisterMethods: Array<string> | null;
+    };
+    /** 是否开启自定义安全规则 */
+    customSecurityEnabled: boolean;
+    /** 应用的人机验证策略，始终开启、不开启、设置条件触发 */
+    appRobotVerify: 'always_enable' | 'disable' | 'condition_set';
+    /** 用户池的人机验证策略，始终开启、不开启、设置条件触发 */
+    userpoolRobotVerify: 'always_enable' | 'disable' | 'condition_set';
+}

package/types/Type/index.d.ts

@@ -0,0 +1,87 @@
+import React from 'react';
+import { AuthenticationClient, CommonMessage, User } from 'authing-js-sdk';
+import { GuardModuleType } from '../Guard/module';
+import { FacePlugin } from '../_utils/facePlugin/interface';
+import { ApplicationConfig } from './application';
+export * from './application';
+export type { CommonMessage, User };
+export type Lang = 'zh-CN' | 'en-US' | 'zh-TW' | 'ja-JP';
+export declare enum GuardMode {
+    Modal = "modal",
+    Normal = "normal"
+}
+export interface IG2FCProps extends IG2Events {
+    appId?: string;
+    tenantId?: string;
+    deviceId?: string;
+    config?: Partial<IG2Config>;
+    visible?: boolean;
+    initData?: any;
+    appendConfig?: GuardAppendConfig;
+    facePlugin?: FacePlugin;
+    authClient?: AuthenticationClient;
+}
+export interface GuardAppendConfig {
+    internalRequest?: boolean;
+    singleComponent?: boolean;
+    unAuthFlow?: boolean;
+    publicConfig?: ApplicationConfig;
+    pageConfig?: GuardPageConfig;
+}
+export interface IG2FCViewProps extends IG2FCProps {
+    config: IG2Config;
+}
+export interface IG2Config {
+    title?: string;
+    logo?: string;
+    lang?: string;
+    langRange?: Lang[];
+    host: string;
+    isHost?: boolean;
+    mode: GuardMode;
+    clickCloseable: boolean;
+    escCloseable: boolean;
+    userpool?: string;
+    contentCss?: string;
+    target?: HTMLElement | string;
+    style?: React.CSSProperties;
+    __internalRequest__?: boolean;
+    __singleComponent__?: boolean;
+    __unAuthFlow__?: boolean;
+}
+export interface IG2Events {
+    onLoad?: (authClient: AuthenticationClient) => void;
+    onLoadError?: (error: any) => void;
+    onClose?: () => void;
+    onLangChange?: (lang: Lang) => void;
+    __changeModule?: (moduleName: GuardModuleType, initData?: any) => void;
+}
+export declare const getDefaultG2Config: () => IG2Config;
+export declare const LanguageMap: any;
+export declare enum InputMethod {
+    EmailCode = "email-code",
+    PhoneCode = "phone-code"
+}
+export declare enum GuardPageSene {
+    Global = "global"
+}
+export interface GuardPageConfig {
+    [GuardPageSene.Global]: {
+        showChangeLanguage: boolean;
+        defaultLanguage: Lang | 'browser';
+    };
+}
+export declare 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",
+    SELF_UNLOCKING_VERIFY_CODE = "SELF_UNLOCKING_VERIFY_CODE"
+}

package/types/UploadImage/index.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+export declare const UploadImage: FC<{
+    value?: string;
+    onChange?: (value: string) => void;
+}>;

package/types/ValidatorRules/PasswordFormItem.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { PasswordFormItemProps } from '.';
+export interface ExPasswordFormItemProps extends PasswordFormItemProps {
+    fieldRequiredRuleMessage?: string;
+}
+export declare const PasswordFormItem: React.FC<ExPasswordFormItemProps>;

package/types/ValidatorRules/ValidatorFormItem.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { ValidatorFormItemProps } from '.';
+export declare const EmailFormItem: React.FC<ValidatorFormItemProps>;
+export declare const PhoneFormItem: React.FC<ValidatorFormItemProps>;
+export declare const UserNameFormItem: React.FC<ValidatorFormItemProps>;
+export declare const CustomNameFormItem: React.FC<ValidatorFormItemProps & {
+    method: string;
+}>;

package/types/ValidatorRules/index.d.ts

@@ -0,0 +1,32 @@
+import { FormInstance, FormItemProps } from 'antd/lib/form';
+import FormItem from 'antd/lib/form/FormItem';
+import { PasswordFormItem } from './PasswordFormItem';
+import { EmailFormItem, PhoneFormItem, UserNameFormItem, CustomNameFormItem } from './ValidatorFormItem';
+export interface ValidatorFormItemProps extends FormItemProps {
+    form?: FormInstance;
+    checkRepeat?: boolean;
+    checkExist?: boolean;
+    areaCode?: string;
+    /**
+     * 控制内部FormItem组件关于pattern的校验规则
+     */
+    isCheckPattern?: boolean;
+}
+export interface ValidatorFormItemMetaProps extends ValidatorFormItemProps {
+    method: 'email' | 'phone' | 'username' | string;
+}
+export interface PasswordFormItemProps extends FormItemProps {
+}
+export interface ICheckProps {
+    check: (values: any) => void;
+}
+type InternalFormItemType = typeof FormItem;
+interface FormItemInterface extends InternalFormItemType {
+    Password: typeof PasswordFormItem;
+    Email: typeof EmailFormItem;
+    Phone: typeof PhoneFormItem;
+    UserName: typeof UserNameFormItem;
+    CustomName: typeof CustomNameFormItem;
+}
+declare const CustomFormItem: FormItemInterface;
+export default CustomFormItem;

package/types/ValidatorRules/useCheckRepeat.d.ts

@@ -0,0 +1 @@
+export declare const useCheckRepeat: (checkFn: (value: any, resolve: (value: unknown) => void, reject: (reason?: any) => void) => void) => (_: any, value: any) => Promise<unknown>;

package/types/VerifyCodeInput/index.d.ts

@@ -0,0 +1,10 @@
+import React, { FC } from 'react';
+import './style.less';
+interface VerifyCodeInputProps extends React.HTMLAttributes<HTMLDivElement> {
+    verifyCode: string[];
+    setVerifyCode: (code: string[]) => void;
+    length?: number;
+    onEnter?: Function;
+}
+export declare const VerifyCodeInput: FC<VerifyCodeInputProps>;
+export {};

package/types/_utils/GuardErrorCode.d.ts

@@ -0,0 +1,12 @@
+export declare enum ErrorCode {
+    OTP_MFA_CODE = 1635,
+    APP_MFA_CODE = 1636,
+    INPUT_CAPTCHACODE = 2000,
+    USER_EXISTENCE = 2026,
+    LOGIN_INVALID = 2021,
+    PASSWORD_ERROR = 2333,
+    USER_NOT_EXIST = 2004,
+    MULTIPLE_ERROR_LOCK = 2057,
+    ACCOUNT_LOCK = 2005,
+    SELECT_ACCOUNT_2_LOGIN = 2930
+}

package/types/_utils/appendConfig.d.ts

@@ -0,0 +1,4 @@
+import { GuardAppendConfig } from '..';
+export declare const getAppendConfig: () => GuardAppendConfig;
+export declare const useAppendConfig: () => GuardAppendConfig;
+export declare const initAppendConfig: (appendConfig?: GuardAppendConfig) => void;

package/types/_utils/clipboard.d.ts

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

package/types/_utils/config/index.d.ts

@@ -0,0 +1,110 @@
+/// <reference types="react" />
+import { GuardLocalConfig } from '../../Guard/config';
+import { GuardHttp } from '../guardHttp';
+import { GuardPageConfig } from '../../Type';
+import { ApplicationConfig, LoginMethods } from '../../Type/application';
+export declare const getPublicConfig: (appId: string) => ApplicationConfig;
+export declare const setPublicConfig: (appId: string, config: ApplicationConfig) => ApplicationConfig;
+export declare const getPageConfig: (appId: string) => GuardPageConfig;
+export declare const setPageConfig: (appId: string, config: GuardPageConfig) => GuardPageConfig;
+export declare const useMergeDefaultConfig: (defaultConfig: GuardLocalConfig, config?: Partial<GuardLocalConfig>) => GuardLocalConfig | undefined;
+/**
+ * 请求服务console关于guard的配置
+ * @param forceUpdate
+ * @param appId
+ * @param config
+ * @param httpClient
+ * @param setError
+ */
+export declare const useFetchConsoleConfig: (forceUpdate: number, appId?: string, config?: GuardLocalConfig, httpClient?: GuardHttp, setError?: any) => {
+    finallyConfig: {
+        host: string;
+        isSSO?: boolean | undefined;
+        defaultScenes?: import("../..").GuardModuleType | undefined;
+        defaultInitData?: any;
+        showLoading?: boolean | undefined;
+        loadingComponent?: import("react").ReactNode;
+        openEventsMapping?: boolean | undefined;
+        disableRegister?: boolean | undefined;
+        registerMethods?: string[] | undefined;
+        defaultRegisterMethod?: string | undefined;
+        publicKey?: string | undefined;
+        agreementEnabled?: boolean | undefined;
+        agreements?: import("../../Type").Agreement[] | undefined;
+        registerContext?: any;
+        title?: string | undefined;
+        logo?: string | undefined;
+        lang?: string | undefined;
+        langRange?: import("../../Type").Lang[] | undefined;
+        isHost?: boolean | undefined;
+        mode: import("../../Type").GuardMode;
+        clickCloseable: boolean;
+        escCloseable: boolean;
+        userpool?: string | undefined;
+        contentCss?: string | undefined;
+        target?: string | HTMLElement | undefined;
+        style?: import("react").CSSProperties | undefined;
+        __internalRequest__?: boolean | undefined;
+        __singleComponent__?: boolean | undefined;
+        __unAuthFlow__?: boolean | undefined;
+        autoRegister?: boolean | undefined;
+        disableResetPwd?: boolean | undefined;
+        defaultLoginMethod?: LoginMethods | undefined;
+        loginMethods?: LoginMethods[] | undefined;
+        passwordLoginMethods?: string[] | undefined;
+        socialConnections?: import("../../Type").SocialConnectionProvider[] | undefined;
+        socialConnectionsBtnShape?: "default" | "button" | "icon" | undefined;
+        enterpriseConnections?: string[] | undefined;
+        qrCodeScanOptions?: {
+            extIdpConnId?: string | undefined;
+            autoExchangeUserInfo?: boolean | undefined;
+            size?: {
+                height: number;
+                width: number;
+            } | undefined;
+            containerSize?: {
+                height: number;
+                width: number;
+            } | undefined;
+            interval?: number | undefined;
+            onStart?: ((timer: any) => any) | undefined;
+            onResult?: ((data: import("authing-js-sdk/build/main/lib/authentication/types").QRCodeStatus) => any) | undefined;
+            onScanned?: ((userInfo: import("authing-js-sdk/build/main/lib/authentication/types").QRCodeUserInfo) => any) | undefined;
+            onSuccess?: ((userInfo: import("authing-js-sdk/build/main/lib/authentication/types").QRCodeUserInfo, ticket: string) => any) | undefined;
+            onCancel?: (() => any) | undefined;
+            onError?: ((message: string) => any) | undefined;
+            onExpired?: (() => any) | undefined;
+            onCodeShow?: ((random: string, url: string) => any) | undefined;
+            onCodeLoaded?: ((random: string, url: string) => any) | undefined;
+            onCodeLoadFailed?: ((message: string) => any) | undefined;
+            onCodeDestroyed?: ((random: string) => any) | undefined;
+            onRetry?: (() => any) | undefined;
+            onMfa?: ((code: number, message: string, data: Record<string, any>) => {}) | undefined;
+            tips?: {
+                title?: string | undefined;
+                scanned?: string | undefined;
+                succeed?: string | undefined;
+                canceled?: string | undefined;
+                expired?: string | undefined;
+                retry?: string | undefined;
+                failed?: string | undefined;
+                middleTitle?: string | undefined;
+                referText?: string | undefined;
+            } | undefined;
+            onAuthFlow?: ((flow: Record<string, any>) => {}) | undefined;
+            customData?: {
+                [x: string]: any;
+            } | undefined;
+            context?: {
+                [x: string]: any;
+            } | undefined;
+            withCustomData?: boolean | undefined;
+        } | undefined;
+        _closeLoopCheckQrcode?: boolean | undefined;
+        goBack?: (() => void) | null | undefined;
+    };
+    guardPageConfig: GuardPageConfig;
+} | {
+    finallyConfig: undefined;
+    guardPageConfig: undefined;
+};