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

package/out/utils/upload/upload-file.js

@@ -0,0 +1,150 @@
+/* eslint-disable @typescript-eslint/no-empty-function */
+/* eslint-disable no-param-reassign */
+import { cloneDeep, isFunction, merge, round, uniqueId } from 'lodash-es';
+import { selectFile } from './select-file';
+/**
+ * 使用上传文件逻辑
+ *
+ * @author lxm
+ * @date 2022-11-20 21:11:52
+ * @export
+ * @param {IUploadFileOpts} _opts
+ * @returns {*}
+ */
+export function uploadFile(_opts) {
+    const opts = merge({
+        multiple: true,
+        accept: '',
+        separate: true,
+        beforeUpload: (_fileData, _files) => true,
+        finish: (_resultFiles) => { },
+        success: (_resultFiles, _res) => { },
+        error: (_resultFiles, _error) => { },
+        progress: (_files) => { },
+    }, _opts);
+    /**
+     * 进度条回调
+     *
+     * @author lxm
+     * @date 2022-11-20 21:11:47
+     * @param {IParams} event
+     * @param {IUploadFile[]} files
+     */
+    const onUploadProgress = (event, files) => {
+        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, onProgress) => {
+        // 自定义上传请求
+        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) => {
+        const resultFiles = 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) => {
+        const uploadSequence = opts.separate ? files.map(file => [file]) : [files];
+        const res = await Promise.allSettled(uploadSequence.map(async (sequence) => {
+            return executeSingleUpload(sequence);
+        }));
+        // 整合所有的返回文件
+        const resultFiles = [];
+        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();
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ibiz-template/core",
-  "version": "0.0.1-beta.1",
+  "version": "0.0.1-beta.130",
   "description": "核心包",
   "type": "module",
   "main": "out/index.js",
@@ -30,7 +30,7 @@
   "author": "chitanda",
   "license": "MIT",
   "dependencies": {
-    "axios": "^1.1.3",
+    "axios": "^1.2.1",
     "loglevel": "^1.8.0",
     "pluralize": "^8.0.0",
     "qs": "^6.11.0"
@@ -39,11 +39,12 @@
     "@types/pluralize": "^0.0.29",
     "@types/qs": "^6.9.7",
     "lodash-es": "^4.17.21",
-    "qx-util": "^0.4.4"
+    "qx-util": "^0.4.8",
+    "ramda": "^0.28.0"
   },
   "peerDependencies": {
     "lodash-es": "^4.17.21",
-    "qx-util": "^0.4.4"
-  },
-  "gitHead": "9514cbc720208af6160c67bc43e822262274da1f"
+    "qx-util": "^0.4.8",
+    "ramda": "^0.28.0"
+  }
 }

package/src/constant/core/core.ts

@@ -20,4 +20,14 @@ export class CoreConst {
    * @static
    */
   static readonly TOKEN = 'access_token';
+
+  /**
+   * 访问令牌标识过期时间
+   *
+   * @author lxm
+   * @date 2023-02-13 07:11:33
+   * @static
+   * @memberof CoreConst
+   */
+  static readonly TOKEN_EXPIRES = 'access_token_expires';
 }

package/src/context/index.ts

@@ -1,3 +1,5 @@
+import { clone } from 'ramda';
+
 /**
  * 上下文处理类
  *
@@ -10,24 +12,65 @@ export class IBizContext implements IContext {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [key: string | symbol]: any;
 
-  protected _context!: IContext;
+  /**
+   * clone 后引用的上下文实例，需要在实例销毁时，同时销毁
+   *
+   * @author chitanda
+   * @date 2023-03-13 16:03:31
+   * @protected
+   * @type {IBizContext[]}
+   */
+  protected declare _associationContext: IBizContext[];
+
+  /**
+   * 修改的父上下文
+   *
+   * @author lxm
+   * @date 2022-12-08 18:12:16
+   * @protected
+   * @type {IData}
+   */
+  protected declare _context: IData;
+
+  /**
+   * 父的上下文源对象
+   *
+   * @author lxm
+   * @date 2022-12-08 18:12:31
+   * @type {IContext}
+   */
+  declare _parent?: IContext;
 
   /**
    * Creates an instance of IBizContext.
    *
    * @author chitanda
    * @date 2022-07-14 10:07:15
-   * @param {IContext} [context={}] 自身的上下文
-   * @param {IBizContext} [parent]
+   * @param {IData} [context={}] 自身的上下文
+   * @param {IContext} [parent]
    */
   // eslint-disable-next-line default-param-last
-  constructor(context: IContext = {}, parent?: IBizContext) {
+  private constructor(context: IData = {}, parent?: IContext) {
+    Object.defineProperty(this, '_associationContext', {
+      enumerable: false,
+      value: [],
+    });
+
     if (parent) {
       // eslint-disable-next-line @typescript-eslint/no-this-alias
       const self = this;
-      // 定义私有变量，用于存储父已有上下文，方便覆盖
+
+      // 定义私有变量，存放父上下文源对象
+      Object.defineProperty(this, '_parent', {
+        enumerable: false,
+        writable: true,
+        value: parent,
+      });
+
+      // 定义私有变量，用于存储对父已有上下文的修改。
       Object.defineProperty(this, '_context', {
         enumerable: false,
+        writable: true,
         value: {},
       });
       // 监控父上下文参数，自身不存在时从父取
@@ -56,4 +99,71 @@ export class IBizContext implements IContext {
     // 合并给入上下文
     Object.assign(this, context);
   }
+
+  /**
+   * 返回自身的上下文，独有的和与父有差异的。
+   *
+   * @author lxm
+   * @date 2022-12-08 17:12:26
+   * @returns {*}  {IData}
+   */
+  getOwnContext(): IData {
+    const result: IData = {};
+    Object.keys(this).forEach(key => {
+      // 父没有的，或者修改了父的上下文
+      // 父不存在则返回所有自身的属性
+      if (
+        !this._parent ||
+        !Object.prototype.hasOwnProperty.call(this._parent, key) ||
+        Object.prototype.hasOwnProperty.call(this._context, key)
+      ) {
+        result[key] = this[key];
+      }
+    });
+    return result;
+  }
+
+  /**
+   * 销毁当前上下文对象
+   *
+   * @author chitanda
+   * @date 2023-03-13 15:03:04
+   */
+  destroy(): void {
+    this._parent = undefined;
+    this._context = {};
+    this._associationContext.forEach(item => {
+      item.destroy();
+    });
+  }
+
+  /**
+   * 在非视图中，需要断开视图上下文联系时。只能使用 clone 创建新的局部上下文
+   *
+   * @author chitanda
+   * @date 2023-03-13 16:03:13
+   * @return {*}  {IBizContext}
+   */
+  clone(): IBizContext {
+    const newContext = new IBizContext(
+      clone(this.getOwnContext()),
+      this._parent,
+    );
+    this._associationContext.push(newContext);
+    return newContext;
+  }
+
+  /**
+   * 上下文只有在视图初始化时，调用 create 方法
+   *
+   * @author chitanda
+   * @date 2023-03-13 16:03:32
+   * @static
+   * @param {IData} [context]
+   * @param {IContext} [parent]
+   * @return {*}  {IContext}
+   */
+  static create(context?: IData, parent?: IContext): IBizContext {
+    return new IBizContext(context, parent);
+  }
 }

package/src/environment/environment.ts

@@ -19,4 +19,9 @@ export const Environment: IEnvironment = {
   loginMode: LoginMode.DEFAULT,
   menuPermissionMode: MenuPermissionMode.MIXIN,
   enablePermission: true,
+  enableWfAllHistory: false,
+  routePlaceholder: '-',
+  loginViewName: 'AppLoginView',
+  version: '0.0.1',
+  favicon: './favicon.ico',
 };

package/src/error/http-error/http-error.ts

@@ -1,5 +1,4 @@
 import { AxiosError, AxiosResponse } from 'axios';
-import { HttpStatusMessageConst } from '../../constant';
 
 /**
  * 请求异常
@@ -28,9 +27,6 @@ export class HttpError implements Error {
       } else {
         this.message = res.statusText;
       }
-      if (!this.message) {
-        this.message = HttpStatusMessageConst[res.status];
-      }
       if (!this.message) {
         this.message = '网络异常，请稍后重试!';
       }

package/src/interface/i-environment/i-environment.ts

@@ -146,4 +146,45 @@ export interface IEnvironment {
    * @type {MenuPermissionMode}
    */
   menuPermissionMode: MenuPermissionMode;
+
+  /**
+   * 是否让所有工作流history接口走all
+   *
+   * @type {boolean}
+   * @memberof IEnvironment
+   */
+  enableWfAllHistory: boolean;
+
+  /**
+   * 路由占位符
+   *
+   * @type {string}
+   * @memberof IEnvironment
+   */
+  routePlaceholder: string;
+
+  /**
+   * 登录页视图组件名称
+   *
+   * @type {string}
+   * @memberof IEnvironment
+   */
+  loginViewName: string;
+
+  /**
+   * 版本
+   *
+   * @type {string}
+   * @memberof IEnvironment
+   */
+  version: string;
+
+  /**
+   * 应用图标地址
+   *
+   * @author chitanda
+   * @date 2023-07-17 17:07:23
+   * @type {string}
+   */
+  favicon?: string;
 }

package/src/types.ts

@@ -27,6 +27,41 @@ declare global {
    */
   interface IContext {
     [key: string | symbol]: any;
+
+    /**
+     * 沙箱标识
+     *
+     * @author chitanda
+     * @date 2022-07-22 15:07:23
+     * @type {string}
+     */
+    srfsandbox?: string;
+
+    /**
+     * 返回自身的上下文，独有的和与父有差异的
+     *
+     * @author chitanda
+     * @date 2023-03-13 17:03:10
+     * @return {*}  {IData}
+     */
+    getOwnContext(): IData;
+
+    /**
+     * 销毁当前上下文
+     *
+     * @author chitanda
+     * @date 2023-03-13 17:03:37
+     */
+    destroy(): void;
+
+    /**
+     * 克隆当前上下文
+     *
+     * @author chitanda
+     * @date 2023-03-13 17:03:45
+     * @return {*}  {IContext}
+     */
+    clone(): IContext;
   }
 
   /**

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

@@ -51,12 +51,33 @@ export function calcMimeByFileName(fileName: string) {
     case '.tar':
       mime = 'application/x-tar';
       break;
+    case '.xlsx':
+      mime = 'application/vnd.ms-excel';
+      break;
     default:
       mime = '';
   }
   return mime;
 }
 
+/**
+ * 判断是否是图片格式
+ *
+ * @author lxm
+ * @date 2022-11-21 13:11:23
+ * @export
+ * @param {string} fileName
+ * @returns {*}  {boolean}
+ */
+export function isImage(fileName: string): boolean {
+  const ext = fileName.split('.').pop();
+  if (!ext) {
+    return false;
+  }
+  const imageTypes = ['.jpeg', 'jpg', 'gif', 'png', 'bmp', 'svg'];
+  return imageTypes.includes(ext);
+}
+
 /**
  * 纯JS触发下载文件
  *

package/src/utils/index.ts

@@ -10,3 +10,7 @@ export * from './event/event';
 export * from './click-outside/click-outside';
 export * from './color/color';
 export * from './download-file/download-file';
+export * from './upload/select-file';
+export * from './upload/upload-file';
+export * from './sync';
+export { StringUtil } from './string-util/string-util';

package/src/utils/net/net.ts

@@ -10,6 +10,7 @@ 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';
 
@@ -32,6 +33,15 @@ 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
@@ -40,6 +50,7 @@ export class Net {
    */
   constructor(config?: CreateAxiosDefaults) {
     this.instance = axios.create(config);
+    this.addInterceptor('Default', new CoreInterceptor());
   }
 
   /**
@@ -91,7 +102,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 +120,15 @@ export class Net {
    * @returns {*}
    */
   protected mergeConfig(...configs: AxiosRequestConfig[]) {
+    const config = this.presetConfig;
     if (configs.length === 0) {
-      return this.presetConfig;
+      return config;
+    }
+    const { url } = configs[0];
+    if (url && this.urlReg.test(url)) {
+      delete config.baseURL;
     }
-    return merge(this.presetConfig, ...configs);
+    return merge(config, ...configs);
   }
 
   /**
@@ -278,6 +294,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);
+  }
+
   /**
    * 统一处理请求返回
    *

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