@ibiz-template/core 0.7.41-alpha.1 → 0.7.41-alpha.106

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

@@ -0,0 +1,76 @@
+import { notNilEmpty } from 'qx-util';
+
+/**
+ * @description 字符串工具类
+ * @export
+ * @class StringUtil
+ */
+export class StringUtil {
+  /**
+   * @description 上下文替换正则
+   * @static
+   * @memberof StringUtil
+   */
+  static contextReg = /\$\{context.[a-zA-Z_$][a-zA-Z0-9_$]{1,}\}/g;
+
+  /**
+   * @description 数据替换正则
+   * @static
+   * @memberof StringUtil
+   */
+  static dataReg = /\$\{data.[a-zA-Z_$][a-zA-Z0-9_$]{1,}\}/g;
+
+  /**
+   * @description 参数替换正则
+   * @static
+   * @memberof StringUtil
+   */
+  static paramsReg = /\$\{params.[a-zA-Z_$][a-zA-Z0-9_$]{1,}\}/g;
+
+  /**
+   * @description 填充字符串中的数据 用法：传入需要替换的字符串和对象 返回值是string类型
+   * @example
+   * ```
+   * StringUtil.fill('姓名:${context.name},年龄:${data.age}', { name: '张三', age: 10 }, {name: '王二', age: 19}, { name: '李四', age: 25 }); // => '姓名:张三,年龄:25'
+   * StringUtil.fill('', { name: '张三', age: 10 }, {name: '王二', age: 19}, { name: '李四', age: 25 }); // => ''
+   * ```
+   * @static
+   * @param {string} str 需填充字符串
+   * @param {IContext} [context] 上下文
+   * @param {IParams} [params] 参数
+   * @param {IData} [data] 数据
+   * @return {*}  {string}
+   * @memberof StringUtil
+   */
+  static fill(
+    str: string,
+    context?: IContext,
+    params?: IParams,
+    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(params)) {
+        const strArr = str.match(this.paramsReg);
+        strArr?.forEach(_key => {
+          const key = _key.slice(9, _key.length - 1);
+          str = str.replace(`\${params.${key}}`, params![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;
+  }
+}

package/src/utils/style/remote-style.ts

@@ -0,0 +1,17 @@
+/**
+ * @description 设置远程样式表
+ * @export
+ * @param {string} url
+ * @returns {*}  {Promise<void>}
+ */
+export async function setRemoteStyle(url: string): Promise<void> {
+  try {
+    const res = await ibiz.net.get(url);
+    const styleDom = document.createElement('style');
+    styleDom.setAttribute('title', 'app-style-css');
+    styleDom.innerText = res.data as unknown as string;
+    document.head.appendChild(styleDom);
+  } catch (error) {
+    ibiz.log.debug(ibiz.i18n.t('core.utils.remoteStylesheet'), url);
+  }
+}

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

@@ -0,0 +1,29 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * @description 设置延迟wait毫米后执行fun方法，返回fun的返回值。用法：传入等待时间，函数和参数 返回fun的返回值
+ * @example
+ * ```
+ * awaitTimeout(100, () => 'Hello, World!'); // => 'Hello, World!'
+ * awaitTimeout(100, (name: string) => `Hello, ${name}!`, ['John']); // => 'Hello, John!'
+ * ```
+ * @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,79 @@
+import { RuntimeError } from '../../error';
+
+/**
+ * @description 计数插销工具类
+ * @export
+ * @class CountLatch
+ */
+export class CountLatch {
+  private promise: Promise<void> | null = null;
+
+  private resolve: ((value: void) => void) | null = null;
+
+  /**
+   * @description 计数，当前等待的异步逻辑个数
+   * @type {number}
+   * @memberof CountLatch
+   */
+  count: number = 0;
+
+  /**
+   * @description 开启promise
+   * @private
+   * @memberof CountLatch
+   */
+  private startPromise(): void {
+    this.promise = new Promise(resolve => {
+      this.resolve = resolve;
+    });
+  }
+
+  /**
+   * @description 结束promise
+   * @private
+   * @memberof CountLatch
+   */
+  private endPromise(): void {
+    if (this.resolve) {
+      this.resolve();
+      this.resolve = null;
+      this.promise = null;
+    }
+  }
+
+  /**
+   * @description 上锁，计数加一，第一次计数，开启异步
+   * @memberof CountLatch
+   */
+  lock(): void {
+    this.count += 1;
+    if (!this.promise) {
+      this.startPromise();
+    }
+  }
+
+  /**
+   * @description 解锁，计数减一，归零时结束异步
+   * @memberof CountLatch
+   */
+  unlock(): void {
+    if (this.count < 1) {
+      throw new RuntimeError(ibiz.i18n.t('core.utils.notMatchLockUnlock'));
+    }
+    this.count -= 1;
+    if (this.count === 0) {
+      this.endPromise();
+    }
+  }
+
+  /**
+   * @description 等待，计数归零异步结束
+   * @returns {*}  {Promise<void>}
+   * @memberof CountLatch
+   */
+  async await(): Promise<void> {
+    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/types/types.ts

@@ -0,0 +1,24 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * 从T里面排除U里相同的属性后剩下的属性组成的类型
+ */
+export type OmitObject<T, U> = { [K in keyof Omit<T, keyof U>]: T[K] };
+
+/**
+ * 返回T和U的并集，其中U里面的属性都变成可选
+ */
+export type PartialWithObject<T, U> = {
+  [K in keyof Omit<T, keyof U>]: T[K];
+} & Partial<U>;
+
+/**
+ * 从T里面只获取索引类型为string的键
+ */
+export type StrKeyOf<T> = {
+  [K in keyof T]: T[K] extends string ? K : never;
+}[keyof T];
+
+/**
+ * 构造函数接口，声明一个返回对象是T的构造函数，不传则返回类型是any
+ */
+export type Constructor<T extends object = any> = new (...args: any[]) => T;

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

@@ -0,0 +1,93 @@
+import { merge } from 'lodash-es';
+
+/**
+ * @description 文件List转数组
+ * @export
+ * @param {FileList} fileList
+ * @returns {*}  {File[]}
+ */
+export function fileListToArr(fileList: FileList): File[] {
+  const files = [];
+  for (let i = 0; i < fileList.length; i++) {
+    files.push(fileList[i]);
+  }
+  return files;
+}
+
+/**
+ * @description JS打开文件上传操作配置参数
+ * @export
+ * @interface SelectFileOpts
+ */
+export interface SelectFileOpts {
+  /**
+   * @description 接受的文件类型
+   * @type {string}
+   * @memberof SelectFileOpts
+   */
+  accept?: string;
+  /**
+   * @description 是否支持多选
+   * @type {boolean}
+   * @memberof SelectFileOpts
+   */
+  multiple?: boolean;
+  /**
+   * @description 选中文件后回调
+   * @memberof SelectFileOpts
+   */
+  onSelected: (_fileList: File[]) => void;
+  /**
+   * @description 没有选中文件，点击了取消的场景
+   * @memberof SelectFileOpts
+   */
+  onCancel?: () => void;
+}
+
+/**
+ * @description JS打开文件上传操作
+ * @export
+ * @param {SelectFileOpts} _opts 配置参数
+ */
+export function selectFile(_opts: SelectFileOpts): void {
+  const opts: { multiple: boolean; accept: string } & 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);
+  let fileCancel = true; // 是否取消
+  input.onchange = (e): void => {
+    const inputEl = e.target as HTMLInputElement;
+    const files = inputEl.files ? fileListToArr(inputEl.files) : [];
+    if (files.length === 0) {
+      return;
+    }
+    // 选中了文件就不算取消
+    fileCancel = false;
+    opts.onSelected(files);
+    inputEl.value = ''; // 如果不置空，相同的文件不会触发change事件
+  };
+  document.body.appendChild(input);
+  input.click();
+  // 模拟取消事件
+  window.addEventListener(
+    'focus',
+    () => {
+      setTimeout(() => {
+        if (fileCancel && opts.onCancel) {
+          // 取消逻辑处理
+          opts.onCancel();
+        }
+      }, 300);
+    },
+    { once: true },
+  );
+
+  document.body.removeChild(input);
+}

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

@@ -0,0 +1,194 @@
+/* eslint-disable @typescript-eslint/no-empty-function */
+/* eslint-disable no-param-reassign */
+import { cloneDeep, isFunction, merge, round, uniqueId } from 'lodash-es';
+import { RuntimeError } from '../../error';
+import { HttpResponse } from '../net/http-response';
+import { selectFile } from './select-file';
+
+export interface IUploadFile {
+  name: string;
+  uid: string;
+  status: 'uploading' | 'finished' | 'fail' | 'cancel';
+  percentage: number;
+  response?: HttpResponse;
+  error?: unknown;
+}
+
+export interface IUploadFileOpts {
+  uploadUrl: string;
+  /**
+   * @description 接受的文件类型
+   * @type {string}
+   * @memberof IUploadFileOpts
+   */
+  accept?: string;
+  /**
+   * @description 是否支持多选
+   * @type {boolean}
+   * @memberof IUploadFileOpts
+   */
+  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;
+}
+
+/**
+ * @description 上传文件
+ * @export
+ * @param {IUploadFileOpts} _opts
+ */
+export function uploadFile(_opts: IUploadFileOpts): void {
+  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,
+  );
+
+  /**
+   * @description 进度条回调
+   * @param {IParams} event
+   * @param {IUploadFile[]} files
+   */
+  const onUploadProgress = (event: IParams, files: IUploadFile[]): void => {
+    files.forEach(file => {
+      file.percentage = round(event.progress * 100);
+    });
+    opts.progress(cloneDeep(files));
+  };
+
+  /**
+   * @description 上传请求方法，返回响应对象
+   * @param {File[]} files
+   * @param {(_event: IParams) => void} _onProgress
+   * @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;
+    throw new RuntimeError(ibiz.i18n.t('core.utils.multiApplicationMode'));
+  };
+
+  /**
+   * @description 执行一次上传，可能是一个文件也可能是多个文件
+   * @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(
+        ibiz.i18n.t('core.utils.uploadFailed', {
+          file: files.map(file => file.name).join(','),
+        }),
+      );
+    }
+    return resultFiles;
+  };
+
+  /**
+   * @description 执行上传文件逻辑
+   * @param {File[]} files
+   * @returns {*}  {Promise<void>}
+   */
+  const uploadFiles = async (files: File[]): Promise<void> => {
+    const uploadSequence = opts.separate ? files.map(file => [file]) : [files];
+    const res = await Promise.allSettled(
+      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 = (): void => {
+    selectFile({
+      accept: opts.accept,
+      multiple: opts.multiple,
+      onSelected: files => {
+        uploadFiles(files);
+      },
+    });
+  };
+
+  select();
+}

package/src/utils/url-helper/url-helper.ts

@@ -0,0 +1,52 @@
+/**
+ * @description 路径解析助手
+ * @export
+ * @class UrlHelper
+ */
+export class UrlHelper {
+  /**
+   * @description 路由路径前面的基础路径。如：http://172.16.103.120:30061/portalwebapp/#/index/appportalview?params=123，返回：http://172.16.103.120:30061/portalwebapp/#
+   * @readonly
+   * @static
+   * @type {string}
+   * @memberof UrlHelper
+   */
+  static get routeBase(): string {
+    const hashIndex = window.location.href.lastIndexOf('#/');
+    return window.location.href.slice(0, hashIndex + 1);
+  }
+
+  /**
+   * @description 应用的的基础路径。如：http://172.16.103.120:30061/portalwebapp/#/index/appportalview?params=123，返回：http://172.16.103.120:30061/portalwebapp
+   * @readonly
+   * @static
+   * @type {string}
+   * @memberof UrlHelper
+   */
+  static get appBase(): string {
+    const { origin, pathname } = window.location;
+    return `${origin}${pathname}`.replace(/\/$/, '');
+  }
+
+  /**
+   * @description #开始到末尾，即路由地址。如：http://172.16.103.120:30061/portalwebapp/#/index/appportalview?params=123，返回：/index/appportalview?params=123
+   * @readonly
+   * @static
+   * @type {string}
+   * @memberof UrlHelper
+   */
+  static get routePath(): string {
+    return window.location.hash.replace('#', '');
+  }
+
+  /**
+   * @description 当前地址的全路径，包含域名和参数。如：http://172.16.103.120:30061/portalwebapp/#/index/appportalview?params=123
+   * @readonly
+   * @static
+   * @type {string}
+   * @memberof UrlHelper
+   */
+  static get fullPath(): string {
+    return window.location.href;
+  }
+}