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

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

@@ -0,0 +1,50 @@
+import { CodeAction } from './responseManagement/interface';
+import { AxiosRequestConfig } from 'axios';
+export declare const requestClient: {
+    (input: RequestInfo, init?: RequestInit | undefined): Promise<any>;
+    get<T>(path: string, query?: Record<string, any>, init?: AxiosRequestConfig<any> | undefined): Promise<AuthingResponse<T>>;
+    post<T_1>(path: string, data: any, config?: {
+        headers: any;
+    } | undefined): Promise<AuthingResponse<T_1>>;
+    postForm<T_2>(path: string, formData: any, config?: {
+        headers: any;
+    } | undefined): Promise<AuthingResponse<T_2>>;
+    baseUrl: string;
+    setBaseUrl(base: string): void;
+    langHeader: string;
+    tenantHeader: string;
+    tenantId: string;
+    setLangHeader(key: string | undefined): void;
+    setTenantHeader(key: string | undefined): void;
+    setTenantId(tenantId: string): void;
+};
+export interface AuthingResponse<T = any> {
+    code?: number;
+    statusCode?: number;
+    apiCode?: number;
+    data?: T;
+    messages?: string;
+    message?: string;
+    flowHandle?: string;
+}
+export interface AuthingGuardResponse<T = any> extends AuthingResponse<T> {
+    /**
+     * 根据 Server 返回状态进行的状态流转函数
+     * 默认响应拦截器中自动调用
+     */
+    onGuardHandling?: () => CodeAction;
+    /**
+     * Response 返回 actions 是否需要模块内部处理
+     * 根据 status === 200 判断
+     */
+    isBusiness?: boolean;
+    /**
+     * 流程是否结束（兼容老版本字段）
+     */
+    isFlowEnd?: boolean;
+    /**
+     * 本次响应 Action 类型
+     * see: packages/react-components/components/_utils/responseManagement/interface.ts
+     */
+    responseActionType?: CodeAction;
+}

package/types/_utils/index.d.ts

@@ -0,0 +1,107 @@
+import { FormInstance, Rule, RuleObject } from 'antd/lib/form';
+import qs from 'qs';
+import { User } from 'authing-js-sdk';
+import { GuardProps } from '../Guard';
+import { ApplicationConfig, ComplateFiledsPlace, LoginMethods, RegisterMethods } from '../Type/application';
+import { Lang } from '../Type';
+import { InputMethod } from 'components';
+export * from './popupCenter';
+export * from './clipboard';
+export declare const VALIDATE_PATTERN: {
+    readonly email: RegExp;
+    readonly phone: RegExp;
+    readonly ip: RegExp;
+    readonly host: RegExp;
+    readonly username: RegExp;
+};
+export declare const validate: (type: keyof typeof VALIDATE_PATTERN, val: string) => boolean;
+export declare const getRequiredRules: (msg: string) => Rule[];
+export declare const fieldRequiredRule: (fieldRequiredRule: string, fieldRequiredRuleMessage?: string | undefined) => Rule[];
+/**
+ * 验证码是否正确
+ * @param form form 实例
+ * @param key 当前 FormItem 对应值的 key，比如当前为邮箱验证码就传入邮箱输入框的 formItem name
+ * @returns Array
+ */
+export declare const fieldCodeCorrect: (form: FormInstance, key: string | undefined, options: {
+    currentMethod: InputMethod;
+    areaCode: string;
+    isInternationSms?: boolean | undefined;
+}) => {
+    validateTrigger: string[];
+    validator: (rule: RuleObject, value: string) => Promise<void>;
+}[];
+export declare function getDeviceName(): string | null | undefined;
+export declare type STYLE_RECORD_KEY = 'appConfig' | 'userConfig';
+export declare const insertStyles: (styles: string | any, recordKey?: "appConfig" | "userConfig" | undefined) => void;
+export declare const removeStyles: (recordKey: STYLE_RECORD_KEY) => void;
+export declare const getClassnames: (classnames: (string | boolean | undefined)[]) => string;
+/**
+ * https://www.itranslater.com/qa/details/2115518846294557696
+ * Simple object check.
+ * @param item
+ * @returns {boolean}
+ */
+export declare function isObject(item: any): any;
+/**
+ * https://www.itranslater.com/qa/details/2115518846294557696
+ * Deep merge two objects.
+ * @param target
+ * @param ...sources
+ */
+export declare function deepMerge<T extends any = any>(target: T, ...sources: any[]): T;
+/**
+ *  在托管页下上传query中指定的用户自定义字段进行补全
+ * @param params 指定上传的用户自定义字段
+ */
+export declare const getUserRegisterParams: (params?: string[] | undefined) => {
+    key: string;
+    value: string | string[] | qs.ParsedQs | qs.ParsedQs[] | undefined;
+}[];
+export declare const isWeChatBrowser: () => boolean | null;
+export declare const isLarkBrowser: () => boolean | null;
+export declare const isQtWebEngine: () => boolean | null;
+export declare const isXiaomiBrowser: () => boolean | null;
+export declare const isDingtalkBrowser: () => boolean | null;
+export declare const isQQBrowser: () => boolean | null;
+export declare const isQQBuiltInBrowser: () => boolean | null;
+export declare const isWeWorkBuiltInBrowser: () => boolean | null;
+export declare const isEdgeBrowser: () => boolean;
+export declare const isWeiboBrowser: () => boolean | null;
+export declare const isAlipayBrowser: () => boolean | null;
+export declare const isBaiduBrowser: () => boolean | null;
+export declare const isWeComeBrowser: () => boolean;
+export declare const isMobile: () => RegExpMatchArray | null;
+export declare const isSpecialBrowser: () => boolean;
+export declare const assembledAppHost: (identifier: string, host: string) => string;
+export declare const assembledRequestHost: (requestHostname: string, configHost: string) => string;
+export declare enum PasswordStrength {
+    NoCheck = 0,
+    Low = 1,
+    Middle = 2,
+    High = 3,
+    AUTO = 4
+}
+export declare const PASSWORD_STRENGTH_TEXT_MAP: Record<PasswordStrength, {
+    placeholder: () => string;
+    validateMessage: () => string;
+}>;
+export declare const getSymbolTypeLength: (pwd: string) => number;
+export declare const getPasswordValidate: (strength?: PasswordStrength, customPasswordStrength?: any, fieldRequiredRuleMessage?: string | undefined) => Rule[];
+export declare const sleep: (delay: number) => Promise<unknown>;
+export declare const shoudGoToComplete: (user: User, contextType: ComplateFiledsPlace, config: ApplicationConfig | undefined, autoRegister?: boolean | undefined) => boolean;
+export declare const tabSort: (defaultValue: any, tabList: RegisterMethods[]) => RegisterMethods[];
+export declare const mailDesensitization: (mail: string) => string;
+export declare const phoneDesensitization: (phone: string) => string;
+export declare const getHundreds: (num: number) => number;
+export declare const GuardPropsFilter: (pre: GuardProps, current: GuardProps) => boolean;
+export declare const getDocumentNode: (node: Node & ParentNode) => Document;
+export declare const getLoginTypePipe: (publicConfig: ApplicationConfig, registerMethod: RegisterMethods) => {
+    specifyDefaultLoginMethod: LoginMethods;
+    lockMethod: string;
+} | {
+    specifyDefaultLoginMethod: LoginMethods;
+    lockMethod?: undefined;
+} | undefined;
+export declare const getPasswordIdentify: (identity: string) => string;
+export declare const getCurrentLng: () => Lang;

package/types/_utils/initAppId.d.ts

@@ -0,0 +1,7 @@
+import { AuthenticationClient } from 'authing-js-sdk';
+export interface UseInitAppidProps {
+    propsAppid?: string;
+    propsAuthClient?: AuthenticationClient;
+    setError?: any;
+}
+export declare const useInitAppId: (propsAppid?: string | undefined, propsAuthClient?: AuthenticationClient | undefined, setError?: any) => string | undefined;

package/types/_utils/locales/en-us/index.d.ts

@@ -0,0 +1,4 @@
+import common from './common.json';
+import login from './login.json';
+import user from './user.json';
+export { common, login, user };

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

@@ -0,0 +1,8 @@
+import i18n from 'i18next';
+import { Lang } from '../../Type';
+declare let i18nReady: boolean;
+export interface InitGuardI18nOptions {
+    defaultLanguage?: Lang | 'browser';
+}
+export declare const initGuardI18n: (options: InitGuardI18nOptions) => void;
+export { i18n, i18nReady };

package/types/_utils/locales/zh-cn/index.d.ts

@@ -0,0 +1,4 @@
+import common from './common.json';
+import login from './login.json';
+import user from './user.json';
+export { common, login, user };

package/types/_utils/locales/zh-tw/index.d.ts

@@ -0,0 +1,4 @@
+import common from './common.json';
+import login from './login.json';
+import user from './user.json';
+export { common, login, user };

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

@@ -0,0 +1,15 @@
+import { LoggerType } from './interface';
+export declare class Logger {
+    static printType: LoggerType[];
+    /**
+     * 打印日志
+     * @param message 日志信息
+     * @param type 日志类型
+     */
+    static log(message: string, type?: LoggerType): void;
+    static info(message: string): void;
+    static warn(message: string): void;
+    static error(message: string): void;
+}
+export declare const getLogger: () => Logger;
+export declare const useLogger: () => Logger;

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

@@ -0,0 +1,5 @@
+export declare enum LoggerType {
+    INFO = "INFO",
+    WARN = "WARN",
+    ERROR = "ERROR"
+}

package/types/_utils/popupCenter.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 在屏幕中心弹出新窗口加载 url
+ * @param url
+ * @param param1
+ */
+export declare const popupCenter: (url: string, { w, h }?: {
+    w: number;
+    h: number;
+}) => void;

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

@@ -0,0 +1,9 @@
+import { AuthingGuardResponse, AuthingResponse } from '../http';
+import { CodeAction } from './interface';
+/**
+ * 全局的错误拦截器
+ * @param res
+ * @param callBack
+ * @returns
+ */
+export declare const errorCodeInterceptor: (res: AuthingResponse<any>, callBack: (code: CodeAction, res: AuthingResponse) => AuthingGuardResponse) => AuthingResponse<any>;

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

@@ -0,0 +1,21 @@
+import { GuardModuleType } from '../../Guard';
+export declare enum CodeAction {
+    CHANGE_MODULE = "changeModule",
+    RENDER_MESSAGE = "renderMessage",
+    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,
+    UNSAFE_PASSWORD_TIP = 2061,
+    UNSAFE_PASSWORD_RESET = 2071
+}
+export declare const ChangeModuleApiCodeMapping: Record<string, GuardModuleType>;

package/types/_utils/useErrorText.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+export declare const usePasswordErrorText: () => {
+    setPasswordErrorTextShow: React.Dispatch<React.SetStateAction<boolean>>;
+    getPassWordUnsafeText: () => JSX.Element;
+};

package/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from './_utils/config';
+export * from './_utils/responseManagement/interface';
+export * from './AuthClientProvider';
+export * from './Guard';
+export * from './Type';
+export * from './version';

package/types/version/index.d.ts

@@ -0,0 +1,2 @@
+import version from './version';
+export default version;

package/types/version/version.d.ts

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