@ibiz-template/core 0.0.1-alpha.6 → 0.0.1-beta.130

package/src/utils/interceptor/interceptor.ts

@@ -1,8 +1,8 @@
-import axios from 'axios';
-import { getToken } from '../util/util';
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 
 /**
- * 默认请求拦截器
+ * 拦截器基类
  *
  * @author chitanda
  * @date 2022-07-20 18:07:11
@@ -10,26 +10,113 @@ import { getToken } from '../util/util';
  * @class Interceptor
  */
 export class Interceptor {
-  constructor() {
-    this.init();
+  /**
+   * 请求拦截器绑定标识
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:20
+   * @private
+   * @type {number}
+   */
+  private requestTag?: number;
+
+  /**
+   * 响应拦截器绑定标识
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:19
+   * @private
+   * @type {number}
+   */
+  private responseTag?: number;
+
+  /**
+   * 请求之前处理
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:41
+   * @protected
+   * @param {AxiosRequestConfig} config
+   * @returns {*}  {Promise<AxiosRequestConfig>}
+   */
+  protected async onBeforeRequest(
+    config: AxiosRequestConfig,
+  ): Promise<AxiosRequestConfig> {
+    return config;
+  }
+
+  /**
+   * 请求失败之后处理
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:40
+   * @protected
+   * @param {*} error
+   */
+  protected onRequestError(error: any) {
+    // 处理请求错误
+    return Promise.reject(error);
+  }
+
+  /**
+   * 响应成功之后处理
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:38
+   * @protected
+   * @param {AxiosResponse} config
+   * @returns {*}  {Promise<AxiosRequestConfig>}
+   */
+  protected async onResponseSuccess(
+    config: AxiosResponse,
+  ): Promise<AxiosResponse> {
+    return config;
+  }
+
+  /**
+   * 响应失败之后处理
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:37
+   * @protected
+   * @param {*} _error
+   */
+  protected onResponseError(error: any) {
+    // 处理响应错误
+    return Promise.reject(error);
+  }
+
+  /**
+   * 使用拦截器
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:28
+   * @param {AxiosInstance} instance
+   */
+  use(instance: AxiosInstance): void {
+    this.requestTag = instance.interceptors.request.use(
+      this.onBeforeRequest,
+      this.onRequestError,
+    );
+    this.responseTag = instance.interceptors.response.use(
+      this.onResponseSuccess,
+      this.onResponseError,
+    );
   }
 
-  protected init(): void {
-    axios.interceptors.request.use(config => {
-      if (!config.headers) {
-        config.headers = {};
-      }
-      config.headers.Authorization = `Bearer ${getToken()}`;
-      const { orgData } = ibiz;
-      if (orgData) {
-        if (orgData.systemid) {
-          config.headers.srfsystemid = orgData.systemid;
-        }
-        if (orgData.orgid) {
-          config.headers.srforgid = orgData.orgid;
-        }
-      }
-      return config;
-    });
+  /**
+   * 移出拦截器
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:27
+   * @param {AxiosInstance} instance
+   */
+  eject(instance: AxiosInstance) {
+    if (this.requestTag) {
+      instance.interceptors.request.eject(this.requestTag);
+    }
+    if (this.responseTag) {
+      instance.interceptors.response.eject(this.responseTag);
+    }
   }
 }

package/src/utils/logger/logger.ts

@@ -0,0 +1,3 @@
+import * as Logger from 'loglevel';
+
+export { Logger };

package/src/utils/net/http-response.ts

@@ -28,7 +28,7 @@ export interface IHttpResponse<T = IData> extends AxiosResponse {
    * @date 2022-08-18 15:08:44
    * @type {boolean}
    */
-  local?: boolean;
+  local: boolean;
 
   data: T;
 
@@ -75,14 +75,11 @@ export class HttpResponse<T = IData> implements IHttpResponse<T> {
 
   statusText: string;
 
-  /**
-   * header 本地仿造时值为空
-   *
-   * @author chitanda
-   * @date 2022-08-18 15:08:46
-   * @type {AxiosResponseHeaders}
-   */
-  headers: AxiosResponseHeaders = {};
+  headers:
+    | AxiosResponseHeaders
+    | Partial<
+        Record<string, string> & { 'set-cookie'?: string[] | undefined }
+      > = {};
 
   /**
    * AxiosResponse 本地仿造时值为空

package/src/utils/net/net.ts

@@ -1,7 +1,17 @@
-import axios, { AxiosError, AxiosRequestHeaders, AxiosResponse } from 'axios';
+import axios, {
+  AxiosError,
+  RawAxiosRequestHeaders,
+  AxiosResponse,
+  AxiosRequestConfig,
+  AxiosInstance,
+  CreateAxiosDefaults,
+} from 'axios';
+import { merge } from 'lodash-es';
 import { stringify } from 'qs';
 import { notNilEmpty } from 'qx-util';
 import { HttpError } from '../../error';
+import { CoreInterceptor } from '../interceptor';
+import { Interceptor } from '../interceptor/interceptor';
 import { IHttpResponse } from './http-response';
 
 /**
@@ -14,58 +24,136 @@ import { IHttpResponse } from './http-response';
  */
 export class Net {
   /**
-   * 标准请求前缀
+   * axios实例
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:18
+   * @protected
+   * @type {AxiosInstance}
+   */
+  protected instance: AxiosInstance;
+
+  /**
+   * 是否为 http || https 开头
    *
    * @author chitanda
-   * @date 2022-07-21 10:07:48
+   * @date 2022-11-07 14:11:28
    * @protected
-   * @type {string}
    */
-  protected _prefix: string = '';
+  protected urlReg = /^http[s]?:\/\/[^\s]*/;
 
-  get prefix(): string {
-    return this._prefix || ibiz.env.baseUrl;
+  /**
+   * Creates an instance of Net.
+   * @author lxm
+   * @date 2022-10-27 16:10:05
+   * @param {CreateAxiosDefaults} [config] 创建实例用的默认配置
+   */
+  constructor(config?: CreateAxiosDefaults) {
+    this.instance = axios.create(config);
+    this.addInterceptor('Default', new CoreInterceptor());
   }
 
   /**
-   * Creates an instance of Net.
+   * 注册的拦截器
    *
-   * @author chitanda
-   * @date 2022-07-21 10:07:27
-   * @param {string} [prefix] 请求前缀
+   * @author lxm
+   * @date 2022-10-27 17:10:18
+   * @type {Map<string, Interceptor>}
+   */
+  interceptors: Map<string, Interceptor> = new Map();
+
+  /**
+   * 添加拦截器
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:42
+   * @param {string} name 唯一标识
+   * @param {Interceptor} interceptor 拦截器
    */
-  constructor(prefix?: string) {
-    if (prefix) {
-      this._prefix = prefix;
+  addInterceptor(name: string, interceptor: Interceptor) {
+    interceptor.use(this.instance);
+    this.interceptors.set(name, interceptor);
+  }
+
+  /**
+   * 删除拦截器
+   *
+   * @author lxm
+   * @date 2022-10-27 17:10:27
+   * @param {string} name 唯一标识
+   */
+  removeInterceptor(name: string) {
+    const interceptor = this.interceptors.get(name);
+    if (interceptor) {
+      interceptor.eject(this.instance);
+      this.interceptors.delete(name);
     }
   }
 
+  /**
+   * 预置config,绑定动态的配置
+   *
+   * @author lxm
+   * @date 2022-10-27 16:10:48
+   * @readonly
+   * @protected
+   * @type {AxiosRequestConfig}
+   */
+  protected get presetConfig(): AxiosRequestConfig {
+    return {
+      // 请求前缀路径
+      baseURL: ibiz.env.baseUrl,
+      headers: {
+        'Content-Type': 'application/json;charset=UTF-8',
+        Accept: 'application/json',
+      },
+    };
+  }
+
+  /**
+   * 从左到右递归合并配置参数（内置第一个合并的预置参数）
+   *
+   * @author lxm
+   * @date 2022-10-27 16:10:09
+   * @protected
+   * @param {...AxiosRequestConfig[]} configs
+   * @returns {*}
+   */
+  protected mergeConfig(...configs: AxiosRequestConfig[]) {
+    const config = this.presetConfig;
+    if (configs.length === 0) {
+      return config;
+    }
+    const { url } = configs[0];
+    if (url && this.urlReg.test(url)) {
+      delete config.baseURL;
+    }
+    return merge(config, ...configs);
+  }
+
   /**
    * Post 请求
    *
    * @author chitanda
-   * @date 2022-07-14 15:07:01
+   * @date 2022-10-19 11:10:30
    * @param {string} url
+   * @param {IData} data
    * @param {IParams} [params={}]
+   * @param {RawAxiosRequestHeaders} [headers={}]
    * @return {*}  {Promise<IHttpResponse>}
    */
   async post(
     url: string,
     data: IData,
     params: IParams = {},
-    headers: AxiosRequestHeaders = {},
+    headers: RawAxiosRequestHeaders = {},
   ): Promise<IHttpResponse> {
     url = this.handleAppPresetParam(url, params);
     try {
-      const response = await axios({
+      const response = await this.request(url, {
         method: 'post',
-        url,
         data,
-        headers: {
-          'Content-Type': 'application/json;charset=UTF-8',
-          Accept: 'application/json',
-          ...headers,
-        },
+        headers,
       });
       return this.doResponseResult(response);
     } catch (error) {
@@ -77,16 +165,18 @@ export class Net {
    * Get 请求
    *
    * @author chitanda
-   * @date 2022-07-14 15:07:08
+   * @date 2022-10-19 11:10:24
    * @param {string} url
    * @param {IParams} [params={}]
+   * @param {RawAxiosRequestHeaders} [headers={}]
+   * @param {IParams} [option={}]
    * @return {*}  {Promise<IHttpResponse>}
    */
   async get(
     url: string,
     params: IParams = {},
-    headers: AxiosRequestHeaders = {},
-    option: IParams = {},
+    headers: RawAxiosRequestHeaders = {},
+    option: AxiosRequestConfig = {},
   ): Promise<IHttpResponse> {
     // if (params.srfparentdata) {
     //   Object.assign(params, params.srfparentdata);
@@ -94,7 +184,10 @@ export class Net {
     // }
     url = this.attachUrlParam(url, params);
     try {
-      const response = await axios.get(url, { headers, ...option });
+      const response = await this.request(
+        url,
+        merge({ method: 'get', headers }, option),
+      );
       return this.doResponseResult(response);
     } catch (error) {
       throw new HttpError(error as AxiosError);
@@ -105,19 +198,20 @@ export class Net {
    * Delete 请求
    *
    * @author chitanda
-   * @date 2022-07-14 15:07:43
+   * @date 2022-10-19 11:10:17
    * @param {string} url
    * @param {IParams} [params]
+   * @param {RawAxiosRequestHeaders} [headers={}]
    * @return {*}  {Promise<IHttpResponse>}
    */
   async delete(
     url: string,
     params?: IParams,
-    headers: AxiosRequestHeaders = {},
+    headers: RawAxiosRequestHeaders = {},
   ): Promise<IHttpResponse> {
     url = this.handleAppPresetParam(url, params);
     try {
-      const response = await axios.delete(url, { headers });
+      const response = await this.request(url, { method: 'delete', headers });
       return this.doResponseResult(response);
     } catch (error) {
       throw new HttpError(error as AxiosError);
@@ -128,20 +222,26 @@ export class Net {
    * Put 请求
    *
    * @author chitanda
-   * @date 2022-07-14 15:07:49
+   * @date 2022-10-19 11:10:11
    * @param {string} url
    * @param {IData} data
+   * @param {IParams} [params={}]
+   * @param {RawAxiosRequestHeaders} [headers={}]
    * @return {*}  {Promise<IHttpResponse>}
    */
   async put(
     url: string,
     data: IData,
     params: IParams = {},
-    headers: AxiosRequestHeaders = {},
+    headers: RawAxiosRequestHeaders = {},
   ): Promise<IHttpResponse> {
     url = this.handleAppPresetParam(url, params);
     try {
-      const response = await axios.put(url, data, { headers });
+      const response = await this.request(url, {
+        method: 'put',
+        data,
+        headers,
+      });
       return this.doResponseResult(response);
     } catch (error) {
       throw new HttpError(error as AxiosError);
@@ -154,15 +254,15 @@ export class Net {
    * @author chitanda
    * @date 2022-07-14 15:07:15
    * @param {string} url
-   * @param {AxiosRequestHeaders} [headers={}]
+   * @param {RawAxiosRequestHeaders} [headers={}]
    * @return {*}  {Promise<IHttpResponse>}
    */
   async getModel(
     url: string,
-    headers: AxiosRequestHeaders = {},
+    headers: RawAxiosRequestHeaders = {},
   ): Promise<IHttpResponse> {
     try {
-      const response = await axios.get(url, {
+      const response = await this.instance.get(url, {
         headers,
       });
       return this.doResponseResult(response);
@@ -171,6 +271,41 @@ export class Net {
     }
   }
 
+  /**
+   * 基础请求方法，会合并预置配置
+   *
+   * @author lxm
+   * @date 2022-10-27 14:10:06
+   * @param {string} url
+   * @param {AxiosRequestConfig} [config={}]
+   * @returns {*}  {Promise<IHttpResponse>}
+   */
+  async request(
+    url: string,
+    config: AxiosRequestConfig = {},
+  ): Promise<IHttpResponse> {
+    try {
+      const response = await this.instance.request(
+        this.mergeConfig({ url }, config),
+      );
+      return this.doResponseResult(response);
+    } catch (error) {
+      throw new HttpError(error as AxiosError);
+    }
+  }
+
+  /**
+   * 创建标准 axios 请求
+   *
+   * @author chitanda
+   * @date 2023-01-30 15:01:27
+   * @param {AxiosRequestConfig<IData>} config
+   * @return {*}
+   */
+  axios(config: AxiosRequestConfig<IData>) {
+    return axios(config);
+  }
+
   /**
    * 统一处理请求返回
    *
@@ -223,7 +358,6 @@ export class Net {
    * @return {*}  {string}
    */
   private attachUrlParam(url: string, params: IParams): string {
-    url = this.attachUrl(url);
     const strParams: string = stringify(params);
     if (notNilEmpty(strParams)) {
       if (url.endsWith('?')) {
@@ -238,17 +372,4 @@ export class Net {
     }
     return url;
   }
-
-  /**
-   * 处理 url 参数
-   *
-   * @author chitanda
-   * @date 2022-07-20 20:07:17
-   * @private
-   * @param {string} url
-   * @return {*}  {string}
-   */
-  private attachUrl(url: string): string {
-    return `${this.prefix}${url}`;
-  }
 }

package/src/utils/plural/plural.ts

@@ -1,5 +1,8 @@
 import pluralize from 'pluralize';
 
+// 补充特殊转换规则
+pluralize.addPluralRule(/(matr|vert|ind)ix|ex$/, '$1ices');
+
 /**
  * 英文转复数写法
  *

package/src/utils/string-util/string-util.ts

@@ -0,0 +1,75 @@
+import { notNilEmpty } from 'qx-util';
+
+/**
+ * 字符串工具类
+ *
+ * @author chitanda
+ * @date 2021-04-23 20:04:27
+ * @export
+ * @class StringUtil
+ */
+export class StringUtil {
+  /**
+   * 上下文替换正则
+   *
+   * @author chitanda
+   * @date 2021-04-23 20:04:01
+   * @static
+   */
+  static contextReg = /\$\{context.[a-zA-Z_$][a-zA-Z0-9_$]{1,}\}/g;
+
+  /**
+   * 数据替换正则
+   *
+   * @author chitanda
+   * @date 2021-04-23 20:04:09
+   * @static
+   */
+  static dataReg = /\$\{data.[a-zA-Z_$][a-zA-Z0-9_$]{1,}\}/g;
+
+  /**
+   * 填充字符串中的数据
+   *
+   * @author chitanda
+   * @date 2021-04-23 20:04:17
+   * @static
+   * @param {string} str
+   * @param {*} [context]
+   * @param {*} [data]
+   * @return {*}  {string}
+   */
+  static fill(str: string, context?: IContext, data?: IData): string {
+    if (notNilEmpty(str)) {
+      if (notNilEmpty(context)) {
+        const strArr = str.match(this.contextReg);
+        strArr?.forEach(_key => {
+          const key = _key.slice(10, _key.length - 1);
+          str = str.replace(`\${context.${key}}`, context![key] || '');
+        });
+      }
+      if (notNilEmpty(data)) {
+        const strArr = str.match(this.dataReg);
+        strArr?.forEach(_key => {
+          const key = _key.slice(7, _key.length - 1);
+          str = str.replace(`\${data.${key}}`, data![key] || '');
+        });
+      }
+    }
+    return str;
+  }
+
+  /**
+   * 动态匹配${}
+   *
+   * @param str
+   * @param values
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  static dynamicMatch(str: string, values: any): string {
+    return str.replace(/\${(.*?)}/g, (_, key) => {
+      const [objKey, propName] = key.split('.');
+      const obj = values[objKey];
+      return obj ? obj[propName] : '';
+    });
+  }
+}

package/src/utils/sync/await-timeout.ts

@@ -0,0 +1,27 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * 设置延迟wait毫米后执行fun方法，返回fun的返回值
+ *
+ * @author lxm
+ * @date 2023-03-06 08:20:57
+ * @export
+ * @template T
+ * @param {number} wait
+ * @param {T} fun
+ * @param {any[]} params
+ * @returns {*}  {Promise<ReturnType<T>>}
+ */
+export async function awaitTimeout<T extends (...args: any) => any>(
+  wait: number,
+  fun?: T,
+  params?: any[],
+): Promise<ReturnType<T> | undefined> {
+  await new Promise(resolve => {
+    setTimeout(() => {
+      resolve(true);
+    }, wait);
+  });
+  if (fun) {
+    return fun(...(params || []));
+  }
+}