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

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/core/WithCode.d.ts

@@ -9,4 +9,9 @@ export interface RegisterWithCodeProps {
     registeContext?: any;
     methods: any[];
 }
+/**
+ * 手机 Code 注册
+ * @param param0
+ * @returns
+ */
 export declare const RegisterWithCode: React.FC<RegisterWithCodeProps>;

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

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

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

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

package/types/Type/application.d.ts

@@ -251,6 +251,9 @@ export interface ApplicationConfig {
     verifyCodeLength: number;
     websocket: string;
     welcomeMessage: any;
+    userPortal?: {
+        mergeAccount?: boolean;
+    };
     skipComplateFileds: boolean;
     selfUnlockStrategy: 'captcha' | 'password-captcha';
     defaultLanguageConfig: Lang;

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

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

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

@@ -0,0 +1,23 @@
+/**
+ * Response Action 是否为渲染信息
+ * @param parseStatusCode
+ * @returns
+ */
+export declare const isRenderMessageByStatusCode: (parseStatusCode: number) => boolean;
+/**
+ * Response Action 是否为内部流程状态处理（交由业务处理）
+ * @param parseStatusCode
+ * @param apiCode
+ */
+export declare const isFlowBusinessByStatusCode: (parseStatusCode: number) => boolean;
+/**
+ * Response Action 是否为流程结束
+ * @param parseStatusCode
+ * @param apiCode
+ */
+export declare const isFlowEndByStatusCode: (parseStatusCode: number, apiCode: number) => boolean;
+/**
+ * Response Action 是否为下个流程
+ * @param parseStatusCode
+ */
+export declare const isNextFlowByStatusCode: (parseStatusCode: number, apiCode: number) => boolean;

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

@@ -28,10 +28,6 @@ export declare const parsePhone: (isInternationSms: boolean, fieldValue: string,
     countryCode: string | undefined;
     phoneNumber: string;
 };
-export declare enum SocialConnectionEvent {
-    Message = "message",
-    Auth = "auth"
-}
 /**
  *
  * @param config

package/types/_utils/http/api/constant.d.ts

@@ -0,0 +1,7 @@
+export declare const authFlowUrl: () => string;
+export declare const VerifyEmailUrl: () => string;
+export declare const validateAccountUrl: () => string;
+export declare const countryListsUrl: () => string;
+export declare const validatePhoneCodeUrl: () => string;
+export declare const validateEmailCodeUrl: () => string;
+export declare const sendPhoneCodeUrl: () => string;

package/types/_utils/http/api/index.d.ts

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

package/types/_utils/http/api/request.d.ts

@@ -0,0 +1,72 @@
+import { AxiosRequestConfig } from 'axios';
+import { EmailScene, SceneType } from 'components/Type';
+/**
+ * AuthFlow 相关请求
+ * @param data
+ */
+export declare const authFlowByAxios: <A = string, T = any>(data: {
+    action: A;
+    data?: any;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../http").AuthingGuardResponse<T>>;
+/**
+ * 发送邮箱验证码
+ * @param data
+ */
+export declare const sendEmailCodeByAxios: (data: {
+    email: string;
+    scene: EmailScene;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../http").AuthingGuardResponse<any>>;
+/**
+ * 账号登陆前置校验
+ */
+export interface ValidateAccountParams<T = any> {
+    /**
+     * publicConfig.userPoolId
+     */
+    userPoolId?: string;
+    /**
+     * 校验的输入值
+     */
+    key: T;
+    /**
+     * 本次校验类型
+     */
+    type: 'phone' | 'email' | 'username';
+}
+/**
+ * 登陆/注册 前置，校验(用户/手机/邮箱)是否存在/用户是否不存在
+ * @param params
+ * @returns {Promise<boolean>} 是否通过
+ */
+export declare const validateAccountByAxios: <T = boolean>(params: ValidateAccountParams) => Promise<import("../../http").AuthingGuardResponse<T>>;
+/**
+ * 拉取国家列表
+ */
+export declare const getCountryLists: <T extends string>() => Promise<import("../../http").AuthingGuardResponse<Record<T, {
+    zh: {
+        [props: string]: string;
+    };
+    cn: {
+        [props: string]: string;
+    };
+}>>>;
+/**
+ * 验证手机号验证码是否正确
+ */
+export declare const validatePhoneCodeByAxios: (data: {
+    phone: number | string;
+    phoneCode: number | string;
+    phoneCountryCode?: number | string;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../http").AuthingGuardResponse<any>>;
+/**
+ * 验证邮箱验证码是否正确
+ */
+export declare const validateEmailCodeByAxios: (data: {
+    email: number | string;
+    emailCode: number | string;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../http").AuthingGuardResponse<any>>;
+export declare const sendSmsCodeByAxios: (data: {
+    phone: string;
+    phoneCountryCode?: string;
+    scene?: SceneType;
+}, config?: AxiosRequestConfig<any> | undefined) => Promise<import("../../http").AuthingGuardResponse<any>>;

package/types/_utils/http/base/index.d.ts

@@ -0,0 +1,10 @@
+import { AuthenticationClient } from 'authing-js-sdk';
+/**
+ * 修改 baseUrl 配置
+ */
+export declare const setBaseUrl: (baseUrl: string) => void;
+export declare const setAuthClient: (client: AuthenticationClient) => void;
+/**
+ * 设置加密公钥
+ */
+export declare const setPublishByEncrypt: (publishKey?: string | undefined) => void;

package/types/_utils/http/constant.d.ts

@@ -0,0 +1,46 @@
+import { AuthingResponse } from './interceptors/response';
+import { GuardModuleType } from '../../Guard/module';
+import JSEncrypt from 'jsencrypt';
+/**
+ * 加密实例
+ */
+export declare const encryptedInstance: JSEncrypt;
+export declare enum CodeAction {
+    CHANGE_MODULE = "changeModule",
+    RENDER_MESSAGE = "renderMessage",
+    INNER_MODULE = "innerModule",
+    FLOW_END = "flowEnd"
+}
+export declare enum ApiCode {
+    IDENTITY_BINDING_ASK = 1641,
+    IDENTITY_BINDING = 1640,
+    APP_MFA = 1636,
+    MFA = 1635,
+    ABORT_FLOW = 1699,
+    COMPLETE_INFO = 1642,
+    UNLOCK = 1643,
+    FLOW_END = 1600,
+    FIRST_LOGIN_PASSWORD = 1639,
+    FORCED_PASSWORD_RESET = 2058
+}
+/**
+ * APi Code 对应的模块映射
+ */
+export declare const ChangeModuleApiCodeMapping: Record<string, GuardModuleType>;
+/**
+ * 高阶函数 记录每次请求的 responseData
+ * 同时根据返回的 apiCode 对应的 action 处理
+ * @param responseData
+ * @returns
+ */
+export declare const getCodeActionMapping: (responseData: AuthingResponse) => {
+    /**
+     * 返回的 apiCode 匹配跳转模块时
+     * @param responseData
+     * @returns
+     */
+    changeModule: () => CodeAction;
+    renderMessage: () => CodeAction;
+    innerModule: () => CodeAction;
+    flowEnd: () => CodeAction;
+};

package/types/_utils/http/events/index.d.ts

@@ -0,0 +1,16 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { AuthingGuardResponse } from 'components/_utils/http';
+import { setLoginEvents, setRegisterEvents } from './utils';
+/**
+ * 请求前置事件处理
+ * 比如 beforeLogin / beforeRegister
+ * @param config
+ * @returns
+ */
+declare const processBeforeRequestEvent: (config: AxiosRequestConfig) => Promise<boolean>;
+/**
+ * 响应器拦截 Events
+ * @param response
+ */
+declare const processEventsByResponse: (response: AxiosResponse<AuthingGuardResponse>) => void;
+export { setLoginEvents, setRegisterEvents, processEventsByResponse, processBeforeRequestEvent, };

package/types/_utils/http/events/modal/login.d.ts

@@ -0,0 +1,62 @@
+import { AuthenticationClient } from 'authing-js-sdk';
+import { AuthingResponse } from 'service/interceptors/response';
+declare class LoginEventsManage {
+    private static instance;
+    private successEvent;
+    private failEvent;
+    private constructor();
+    /**
+     * 设置登录成功的回调函数
+     */
+    private setSuccessEvent;
+    /**
+     * 设置失败成功的回调函数
+     */
+    private setFailEvent;
+    /**
+     * 获取登录成功的回调函数
+     */
+    private getSuccessEvents;
+    /**
+     * 获取失败成功的回调函数
+     */
+    private getFailEvents;
+    /**
+     * 判断本次响应是否算做成功的方法
+     */
+    private isLoginSuccess;
+    /**
+     * 触发登录成功事件
+     * @param responseData
+     */
+    private emitSuccessEvent;
+    /**
+     * 触发登录失败事件
+     * @param responseData
+     */
+    private emitFailEvent;
+    /**
+     * 当前是否请求失败
+     * statusCode 4xx 5xx 请求失败
+     */
+    private isLoginFail;
+    /**
+     * 统一触发事件
+     * @param responseData
+     * @param client
+     */
+    private emitEvents;
+    /**
+     * 获取登录事件实例
+     */
+    static getInstance: () => LoginEventsManage;
+    getCallableMethod(): {
+        getSuccessEvents: () => ((user: import("authing-js-sdk").User, authClient: AuthenticationClient) => void) | null | undefined;
+        setSuccessEvent: (successEvents: ((user: import("authing-js-sdk").User, authClient: AuthenticationClient) => void) | undefined) => void;
+        setFailEvent: (failEvent: ((errorMessages: any) => void) | undefined) => void;
+        emitSuccessEvent: (responseData: AuthingResponse<any>, client: AuthenticationClient) => void;
+        emitFailEvent: (responseData: AuthingResponse<any>) => void;
+        emitEvents: (responseData: AuthingResponse<any>, client: AuthenticationClient) => void;
+    };
+}
+export { LoginEventsManage };

package/types/_utils/http/events/modal/register.d.ts

@@ -0,0 +1,73 @@
+import { AuthenticationClient } from 'authing-js-sdk';
+import { AuthingResponse } from 'service/interceptors/response';
+declare type ConditionTypeFunction = (responseData: AuthingResponse) => boolean;
+declare class RegisterEventsManage {
+    private static instance;
+    private successEvent;
+    private failEvent;
+    private constructor();
+    /**
+     * 设置注册成功的回调函数
+     */
+    private setSuccessEvent;
+    /**
+     * 设置失败成功的回调函数
+     */
+    private setFailEvent;
+    /**
+     * 获取注册成功的回调函数
+     */
+    private getSuccessEvents;
+    /**
+     * 获取失败成功的回调函数
+     */
+    private getFailEvents;
+    /**
+     * 内置校验：判断本次响应是否算做成功的方法
+     */
+    private isRegisterSuccess;
+    /**
+     * 触发注册成功事件
+     * @param responseData
+     * @param successCondition 自定义的注册成功事件
+     */
+    private emitSuccessEvent;
+    /**
+     * 触发注册失败事件
+     * @param responseData
+     * @param failCondition 自定义的请求失败条件
+     */
+    private emitFailEvent;
+    /**
+     * 内置校验：当前是否请求失败
+     */
+    private isRegisterFail;
+    /**
+     * 统一触发事件
+     * @param responseData
+     * @param client
+     */
+    private emitEvents;
+    /**
+     * 获取注册事件实例
+     */
+    static getInstance: () => RegisterEventsManage;
+    getCallableMethod(): {
+        setSuccessEvent: (successEvents: ((user: import("authing-js-sdk").User, authClient: AuthenticationClient) => void) | undefined) => void;
+        setFailEvent: (failEvent: ((error: any) => void) | undefined) => void;
+        emitSuccessEvent: (params: {
+            responseData: AuthingResponse<any>;
+            client: AuthenticationClient;
+            condition?: ConditionTypeFunction | undefined;
+        }) => void;
+        emitFailEvent: (params: {
+            responseData: AuthingResponse<any>;
+            condition?: ConditionTypeFunction | undefined;
+        }) => void;
+        emitEvents: (responseData: AuthingResponse<any>, client: AuthenticationClient, options?: {
+            successCondition?: ConditionTypeFunction | undefined;
+            failCondition?: ConditionTypeFunction | undefined;
+        } | undefined) => void;
+    };
+}
+export { RegisterEventsManage };

package/types/_utils/http/events/utils.d.ts

@@ -0,0 +1,25 @@
+import { LoginEventsManage } from './modal/login';
+import { RegisterEventsManage } from './modal/register';
+/**
+ * 内置的登录类型
+ */
+export declare const instanceEventMap: {
+    login: typeof LoginEventsManage;
+    register: typeof RegisterEventsManage;
+};
+/**
+ * 设置登录事件
+ * @returns
+ */
+export declare const setLoginEvents: () => {
+    setSuccessEvent: ((successEvents: ((user: import("authing-js-sdk").User, authClient: import("authing-js-sdk").AuthenticationClient) => void) | undefined) => void) | ((successEvents: ((user: import("authing-js-sdk").User, authClient: import("authing-js-sdk").AuthenticationClient) => void) | undefined) => void);
+    setFailEvent: ((failEvent: ((errorMessages: any) => void) | undefined) => void) | ((failEvent: ((error: any) => void) | undefined) => void);
+};
+/**
+ * 设置注册事件
+ * @returns
+ */
+export declare const setRegisterEvents: () => {
+    setSuccessEvent: ((successEvents: ((user: import("authing-js-sdk").User, authClient: import("authing-js-sdk").AuthenticationClient) => void) | undefined) => void) | ((successEvents: ((user: import("authing-js-sdk").User, authClient: import("authing-js-sdk").AuthenticationClient) => void) | undefined) => void);
+    setFailEvent: ((failEvent: ((errorMessages: any) => void) | undefined) => void) | ((failEvent: ((error: any) => void) | undefined) => void);
+};

package/types/_utils/http/header/index.d.ts

@@ -0,0 +1,41 @@
+/**
+ * 设置 version
+ * @param value
+ * @param key
+ */
+export declare const setVersionByHeader: (value: string, key?: string) => void;
+/**
+ * 设置 sdk version
+ * @param value
+ * @param key
+ */
+export declare const setSdkVersionByHeader: (value: string, key?: string) => void;
+/**
+ * 设置 AppId
+ * @param value
+ * @param key
+ */
+export declare const setAppIdByRequestHeader: (value: string, key?: string) => void;
+/**
+ * 设置 x-authing-app-tenant-id 请求头
+ * @param value
+ * @param key
+ */
+export declare const setTenantIdByRequestHeader: (value?: string | undefined, key?: string) => void;
+/**
+ * 根据 publishConfig 中的 userid 设置
+ * @param value
+ * @param key
+ */
+export declare const setUserPoolIdByRequestHeader: (value: string, key?: string) => void;
+export declare const setLanguageInRequestHeader: () => void;
+/**
+ * 获取当前所有 headers
+ */
+export declare const getHeader: () => import("axios").HeadersDefaults;
+/**
+ * 修改/设置请求头
+ * @param key
+ * @param value
+ */
+export declare const _setRequestHeader: (key: string, value: string) => void;

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

@@ -0,0 +1,6 @@
+import instance from './instance';
+import * as httpHeaderMethods from './header';
+import * as httpEvents from './events';
+import * as httpBaseConfig from './base';
+import * as commonRequest from './api/index';
+export { instance, httpHeaderMethods, httpEvents, httpBaseConfig, commonRequest, };

package/types/_utils/http/instance.d.ts

@@ -0,0 +1,2 @@
+declare const instance: import("axios").AxiosInstance;
+export default instance;

package/types/_utils/http/interceptors/request.d.ts

@@ -0,0 +1,6 @@
+import { AxiosInstance } from 'axios';
+/**
+ * 初始化请求拦截器
+ * @param instance
+ */
+export declare const initRequestInterceptors: (instance: AxiosInstance) => void;

package/types/_utils/http/interceptors/response.d.ts

@@ -0,0 +1,43 @@
+import { AxiosInstance } from 'axios';
+export interface AuthingResponse<T = any> {
+    /**
+     * 错误码
+     */
+    code?: number;
+    /**
+     * 返回状态
+     * 3XX：状态机流转
+     * 4XX｜6XX：错误处理
+     */
+    statusCode?: number;
+    /**
+     * statusCode 3XX 时下个阶段的 code 码
+     */
+    apiCode?: number;
+    /**
+     * 返回的数据
+     */
+    data?: T;
+    /**
+     *
+     */
+    messages?: string;
+    /**
+     *
+     */
+    message?: string;
+    /**
+     * 当前流程 ID
+     * ResponseData 返回则更新当前流程 ID
+     */
+    flowHandle?: string;
+    /**
+     * 响应是否为当前业务内小状态处理
+     * statusCode === 200 下进入该状态
+     */
+    isBusiness?: boolean;
+}
+/**
+ * 初始化响应拦截器
+ */
+export declare const initResponseInterceptors: (instance: AxiosInstance) => void;

package/types/_utils/http/utils.d.ts

@@ -0,0 +1,20 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { AuthingResponse } from './interceptors/response';
+/**
+ * 根据 Response 中的 apiCode & statusCode 做拦截
+ * @param response
+ * @returns
+ */
+export declare const processCodeByResponse: (response: AxiosResponse<AuthingResponse>) => AuthingResponse<any>;
+/**
+ * 处理请求加密字段
+ * @param config
+ * @returns
+ */
+export declare const processEncryptRequestKey: (config: AxiosRequestConfig) => Promise<any>;
+/**
+ * 处理 flowHandler
+ * @param response
+ * @returns
+ */
+export declare const processFlowHandler: (response: AuthingResponse) => AuthingResponse<any>;

package/types/_utils/responseManagement/interface.d.ts

@@ -15,6 +15,7 @@ export declare enum ApiCode {
     FLOW_END = 1600,
     FIRST_LOGIN_PASSWORD = 1639,
     FORCED_PASSWORD_RESET = 2058,
+    ACCOUNT_MERGE = 10000,
     UNSAFE_PASSWORD_TIP = 2061,
     UNSAFE_PASSWORD_RESET = 2071
 }

package/types/version/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.0.3-alpha.0";
+declare const _default: "4.0.3-hep.1";
 export default _default;