@ibiz-template/core 0.0.1-beta.1 → 0.0.1-beta.141

package/src/utils/net/net.ts

@@ -1,15 +1,14 @@
 import axios, {
   AxiosError,
-  RawAxiosRequestHeaders,
   AxiosResponse,
   AxiosRequestConfig,
   AxiosInstance,
-  CreateAxiosDefaults,
 } from 'axios';
 import { merge } from 'lodash-es';
-import { stringify } from 'qs';
+import qs 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';
 
@@ -32,14 +31,24 @@ export class Net {
    */
   protected instance: AxiosInstance;
 
+  /**
+   * 是否为 http || https 开头
+   *
+   * @author chitanda
+   * @date 2022-11-07 14:11:28
+   * @protected
+   */
+  protected urlReg = /^http[s]?:\/\/[^\s]*/;
+
   /**
    * Creates an instance of Net.
    * @author lxm
    * @date 2022-10-27 16:10:05
-   * @param {CreateAxiosDefaults} [config] 创建实例用的默认配置
+   * @param {IData} [config] 创建实例用的默认配置
    */
-  constructor(config?: CreateAxiosDefaults) {
+  constructor(config?: IData) {
     this.instance = axios.create(config);
+    this.addInterceptor('Default', new CoreInterceptor());
   }
 
   /**
@@ -91,7 +100,7 @@ export class Net {
   protected get presetConfig(): AxiosRequestConfig {
     return {
       // 请求前缀路径
-      baseURL: this.instance.defaults.baseURL || ibiz.env.baseUrl,
+      baseURL: ibiz.env.baseUrl,
       headers: {
         'Content-Type': 'application/json;charset=UTF-8',
         Accept: 'application/json',
@@ -109,10 +118,15 @@ export class Net {
    * @returns {*}
    */
   protected mergeConfig(...configs: AxiosRequestConfig[]) {
+    const config = this.presetConfig;
     if (configs.length === 0) {
-      return this.presetConfig;
+      return config;
     }
-    return merge(this.presetConfig, ...configs);
+    const { url } = configs[0];
+    if (url && this.urlReg.test(url)) {
+      delete config.baseURL;
+    }
+    return merge(config, ...configs);
   }
 
   /**
@@ -123,14 +137,14 @@ export class Net {
    * @param {string} url
    * @param {IData} data
    * @param {IParams} [params={}]
-   * @param {RawAxiosRequestHeaders} [headers={}]
+   * @param {IData} [headers={}]
    * @return {*}  {Promise<IHttpResponse>}
    */
   async post(
     url: string,
     data: IData,
     params: IParams = {},
-    headers: RawAxiosRequestHeaders = {},
+    headers: IData = {},
   ): Promise<IHttpResponse> {
     url = this.handleAppPresetParam(url, params);
     try {
@@ -152,14 +166,14 @@ export class Net {
    * @date 2022-10-19 11:10:24
    * @param {string} url
    * @param {IParams} [params={}]
-   * @param {RawAxiosRequestHeaders} [headers={}]
+   * @param {IData} [headers={}]
    * @param {IParams} [option={}]
    * @return {*}  {Promise<IHttpResponse>}
    */
   async get(
     url: string,
     params: IParams = {},
-    headers: RawAxiosRequestHeaders = {},
+    headers: IData = {},
     option: AxiosRequestConfig = {},
   ): Promise<IHttpResponse> {
     // if (params.srfparentdata) {
@@ -185,13 +199,13 @@ export class Net {
    * @date 2022-10-19 11:10:17
    * @param {string} url
    * @param {IParams} [params]
-   * @param {RawAxiosRequestHeaders} [headers={}]
+   * @param {IData} [headers={}]
    * @return {*}  {Promise<IHttpResponse>}
    */
   async delete(
     url: string,
     params?: IParams,
-    headers: RawAxiosRequestHeaders = {},
+    headers: IData = {},
   ): Promise<IHttpResponse> {
     url = this.handleAppPresetParam(url, params);
     try {
@@ -210,14 +224,14 @@ export class Net {
    * @param {string} url
    * @param {IData} data
    * @param {IParams} [params={}]
-   * @param {RawAxiosRequestHeaders} [headers={}]
+   * @param {IData} [headers={}]
    * @return {*}  {Promise<IHttpResponse>}
    */
   async put(
     url: string,
     data: IData,
     params: IParams = {},
-    headers: RawAxiosRequestHeaders = {},
+    headers: IData = {},
   ): Promise<IHttpResponse> {
     url = this.handleAppPresetParam(url, params);
     try {
@@ -238,13 +252,10 @@ export class Net {
    * @author chitanda
    * @date 2022-07-14 15:07:15
    * @param {string} url
-   * @param {RawAxiosRequestHeaders} [headers={}]
+   * @param {IData} [headers={}]
    * @return {*}  {Promise<IHttpResponse>}
    */
-  async getModel(
-    url: string,
-    headers: RawAxiosRequestHeaders = {},
-  ): Promise<IHttpResponse> {
+  async getModel(url: string, headers: IData = {}): Promise<IHttpResponse> {
     try {
       const response = await this.instance.get(url, {
         headers,
@@ -278,6 +289,18 @@ export class Net {
     }
   }
 
+  /**
+   * 创建标准 axios 请求
+   *
+   * @author chitanda
+   * @date 2023-01-30 15:01:27
+   * @param {AxiosRequestConfig<IData>} config
+   * @return {*}
+   */
+  axios(config: AxiosRequestConfig<IData>) {
+    return axios(config);
+  }
+
   /**
    * 统一处理请求返回
    *
@@ -330,7 +353,7 @@ export class Net {
    * @return {*}  {string}
    */
   private attachUrlParam(url: string, params: IParams): string {
-    const strParams: string = stringify(params);
+    const strParams: string = qs.stringify(params);
     if (notNilEmpty(strParams)) {
       if (url.endsWith('?')) {
         url = `${url}${strParams}`;

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 || []));
+  }
+}

package/src/utils/sync/count-latch.ts

@@ -0,0 +1,96 @@
+import { RuntimeError } from '../../error';
+
+/**
+ * 计数插销工具类
+ *
+ * @author lxm
+ * @date 2022-11-24 19:11:49
+ * @export
+ * @class CountLatch
+ */
+export class CountLatch {
+  private promise: Promise<void> | null = null;
+
+  private resolve: ((value: void) => void) | null = null;
+
+  /**
+   * 计数，当前等待的异步逻辑个数
+   *
+   * @author lxm
+   * @date 2022-11-24 19:11:59
+   * @type {number}
+   */
+  count: number = 0;
+
+  /**
+   * 开启promise
+   *
+   * @author lxm
+   * @date 2022-11-24 19:11:32
+   * @private
+   */
+  private startPromise() {
+    this.promise = new Promise(resolve => {
+      this.resolve = resolve;
+    });
+  }
+
+  /**
+   * 结束promise
+   *
+   * @author lxm
+   * @date 2022-11-24 19:11:44
+   * @private
+   */
+  private endPromise() {
+    if (this.resolve) {
+      this.resolve();
+      this.resolve = null;
+      this.promise = null;
+    }
+  }
+
+  /**
+   * 上锁，计数加一
+   * 第一次计数，开启异步
+   *
+   * @author lxm
+   * @date 2022-11-24 19:11:27
+   */
+  lock() {
+    this.count += 1;
+    if (!this.promise) {
+      this.startPromise();
+    }
+  }
+
+  /**
+   * 解锁，计数减一
+   * 归零时结束异步
+   *
+   * @author lxm
+   * @date 2022-11-24 19:11:47
+   */
+  unlock() {
+    if (this.count < 1) {
+      throw new RuntimeError('lock和unlock次数不匹配！');
+    }
+    this.count -= 1;
+    if (this.count === 0) {
+      debugger;
+      this.endPromise();
+    }
+  }
+
+  /**
+   * 等待，计数归零异步结束
+   *
+   * @author lxm
+   * @date 2022-11-24 19:11:20
+   */
+  async await() {
+    if (this.promise) {
+      await this.promise;
+    }
+  }
+}

package/src/utils/sync/index.ts

@@ -0,0 +1,2 @@
+export { awaitTimeout } from './await-timeout';
+export { CountLatch } from './count-latch';

package/src/utils/upload/select-file.ts

@@ -0,0 +1,86 @@
+import { merge } from 'lodash-es';
+
+/**
+ * 文件List转数组
+ *
+ * @author lxm
+ * @date 2022-11-18 13:11:03
+ * @export
+ * @param {FileList} fileList
+ * @returns {*}
+ */
+export function fileListToArr(fileList: FileList): File[] {
+  const files = [];
+  for (let i = 0; i < fileList.length; i++) {
+    files.push(fileList[i]);
+  }
+  return files;
+}
+
+/**
+ * JS打开文件上传操作配置参数
+ *
+ * @author lxm
+ * @date 2022-11-20 21:11:47
+ * @export
+ * @interface SelectFileOpts
+ */
+export interface SelectFileOpts {
+  /**
+   * 接受的文件类型
+   *
+   * @author lxm
+   * @date 2022-11-20 21:11:52
+   * @type {string}
+   */
+  accept?: string;
+  /**
+   * 是否支持多选
+   *
+   * @author lxm
+   * @date 2022-11-20 21:11:52
+   * @type {boolean}
+   */
+  multiple?: boolean;
+  /**
+   * 选中文件后回调
+   *
+   * @author lxm
+   * @date 2022-11-20 21:11:50
+   */
+  onSelected: (_fileList: File[]) => void;
+}
+
+/**
+ * JS打开文件上传操作
+ *
+ * @author lxm
+ * @date 2022-11-20 21:11:31
+ * @export
+ * @param {SelectFileOpts} _opts 配置参数
+ */
+export function selectFile(_opts: SelectFileOpts) {
+  const opts: Required<SelectFileOpts> = merge(
+    {
+      multiple: true,
+      accept: '',
+    },
+    _opts,
+  );
+  const input = document.createElement('input');
+  input.setAttribute('type', 'file');
+  input.setAttribute('multiple', `${opts.multiple}`);
+  input.setAttribute('accept', opts.accept);
+  input.onchange = e => {
+    const inputEl = e.target as HTMLInputElement;
+    const files = inputEl.files ? fileListToArr(inputEl.files) : [];
+    if (files.length === 0) {
+      return;
+    }
+    opts.onSelected(files);
+    inputEl.value = ''; // 如果不置空，相同的文件不会触发change事件
+  };
+  document.body.appendChild(input);
+  input.click();
+  document.body.removeChild(input);
+}

package/src/utils/upload/upload-file.ts

@@ -0,0 +1,207 @@
+/* eslint-disable @typescript-eslint/no-empty-function */
+/* eslint-disable no-param-reassign */
+import { cloneDeep, isFunction, merge, round, uniqueId } from 'lodash-es';
+import { HttpResponse } from '../net/http-response';
+import { selectFile } from './select-file';
+import { promiseAllSettled } from '../util/ie-helper';
+
+export interface IUploadFile {
+  name: string;
+  uid: string;
+  status: 'uploading' | 'finished' | 'fail' | 'cancel';
+  percentage: number;
+  response?: HttpResponse;
+  error?: unknown;
+}
+
+export interface IUploadFileOpts {
+  uploadUrl: string;
+  /**
+   * 接受的文件类型
+   *
+   * @author lxm
+   * @date 2022-11-20 21:11:52
+   * @type {string}
+   */
+  accept?: string;
+  /**
+   * 是否支持多选
+   *
+   * @author lxm
+   * @date 2022-11-20 21:11:52
+   * @type {Boolean}
+   */
+  multiple?: boolean;
+  separate?: string;
+  request?: (_files: File[]) => Promise<HttpResponse>;
+  beforeUpload?: (_fileData: File[], _files: IUploadFile[]) => boolean;
+  finish?: (_resultFiles: IUploadFile[]) => void;
+  success?: (_resultFiles: IUploadFile[], _res: HttpResponse) => void;
+  error?: (_resultFiles: IUploadFile[], _error: unknown) => void;
+  progress?: (_files: IUploadFile[]) => void;
+}
+
+/**
+ * 使用上传文件逻辑
+ *
+ * @author lxm
+ * @date 2022-11-20 21:11:52
+ * @export
+ * @param {IUploadFileOpts} _opts
+ * @returns {*}
+ */
+export function uploadFile(_opts: IUploadFileOpts) {
+  const opts: Required<IUploadFileOpts> = merge(
+    {
+      multiple: true,
+      accept: '',
+      separate: true,
+      beforeUpload: (_fileData: File[], _files: IUploadFile[]) => true,
+      finish: (_resultFiles: IUploadFile[]) => {},
+      success: (_resultFiles: IUploadFile[], _res: HttpResponse) => {},
+      error: (_resultFiles: IUploadFile[], _error: unknown) => {},
+      progress: (_files: IUploadFile[]) => {},
+    },
+    _opts,
+  );
+
+  /**
+   * 进度条回调
+   *
+   * @author lxm
+   * @date 2022-11-20 21:11:47
+   * @param {IParams} event
+   * @param {IUploadFile[]} files
+   */
+  const onUploadProgress = (event: IParams, files: IUploadFile[]) => {
+    files.forEach(file => {
+      file.percentage = round(event.progress * 100);
+    });
+    opts.progress(cloneDeep(files));
+  };
+
+  /**
+   * 上传请求方法，返回响应对象
+   *
+   * @author lxm
+   * @date 2022-11-18 13:11:57
+   * @param {File[]} files
+   * @returns {*}  {Promise<HttpResponse>}
+   */
+  const uploadRequest = async (
+    files: File[],
+    onProgress: (_event: IParams) => void,
+  ): Promise<HttpResponse> => {
+    // 自定义上传请求
+    if (opts.request && isFunction(opts.request)) {
+      return opts.request(files);
+    }
+
+    // 默认每次单个文件上传，可能存在接口一次上传多个文件,
+    const data = new FormData();
+    files.forEach(file => {
+      data.append('file', file);
+    });
+    const res = await ibiz.net.request(opts.uploadUrl, {
+      method: 'post',
+      baseURL: '',
+      data,
+      headers: { 'Content-Type': 'multipart/form-data' },
+      onUploadProgress: onProgress,
+    });
+    return res;
+  };
+
+  /**
+   * 执行一次上传，可能是一个文件也可能是多个文件
+   *
+   * @author lxm
+   * @date 2022-11-18 14:11:54
+   * @param {File[]} files 此次上传文件的集合
+   * @returns {*}  {Promise<IUploadFile[]>}
+   */
+  const executeSingleUpload = async (files: File[]): Promise<IUploadFile[]> => {
+    const resultFiles: IUploadFile[] = files.map(file => {
+      return {
+        status: 'uploading',
+        name: file.name,
+        uid: uniqueId(),
+        percentage: 0,
+      };
+    });
+
+    // 上传前回调，可以取消此次下载
+    const pass = opts.beforeUpload(files, resultFiles);
+    if (!pass) {
+      resultFiles.forEach(file => {
+        file.status = 'cancel';
+      });
+      ibiz.log.debug('取消上传', resultFiles);
+      return resultFiles;
+    }
+
+    try {
+      const res = await uploadRequest(files, event => {
+        onUploadProgress(event, resultFiles);
+      });
+      resultFiles.forEach(file => {
+        file.status = 'finished';
+      });
+      // 上传成功事件
+      opts.success(resultFiles, res);
+      resultFiles.forEach(file => {
+        file.response = res;
+      });
+    } catch (error) {
+      resultFiles.forEach(file => {
+        file.status = 'fail';
+      });
+      // 上传失败事件
+      opts.error(resultFiles, error);
+      resultFiles.forEach(file => {
+        file.error = error;
+      });
+      ibiz.log.error(error);
+      ibiz.log.error(`${files.map(file => file.name).join(',')}上传失败`);
+    }
+    return resultFiles;
+  };
+
+  /**
+   * 执行上传文件逻辑
+   *
+   * @author lxm
+   * @date 2022-11-18 13:11:21
+   * @param {files} File[] 文件集合
+   */
+  const uploadFiles = async (files: File[]) => {
+    const uploadSequence = opts.separate ? files.map(file => [file]) : [files];
+    const res = await promiseAllSettled(
+      uploadSequence.map(async sequence => {
+        return executeSingleUpload(sequence);
+      }),
+    );
+
+    // 整合所有的返回文件
+    const resultFiles: IUploadFile[] = [];
+    res.forEach(result => {
+      if (result.status === 'fulfilled') {
+        resultFiles.push(...result.value);
+      }
+    });
+
+    opts.finish(resultFiles);
+  };
+
+  const select = () => {
+    selectFile({
+      accept: opts.accept,
+      multiple: opts.multiple,
+      onSelected: files => {
+        uploadFiles(files);
+      },
+    });
+  };
+
+  select();
+}