@ibiz-template/runtime 0.7.41-alpha.105 → 0.7.41-alpha.107

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

@@ -0,0 +1,600 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import {
+  CoreConst,
+  IApiContext,
+  IHttpResponse,
+  RuntimeError,
+  downloadFileFromBlob,
+  getAppCookie,
+} from '@ibiz-template/core';
+import qs from 'qs';
+import { convertNavData } from '../nav-params/nav-params';
+import {
+  IApiDownloadTicket,
+  IApiFileUpDownExtraParams,
+  IApiFileUtil,
+} from '../../interface';
+import { DownloadTicketUtil } from './download-ticket/download-ticket-util';
+import { DownloadTicket } from './download-ticket/download-ticket';
+
+/**
+ * @description 文件工具类
+ * @export
+ * @class FileUtil
+ * @implements {IApiFileUtil}
+ */
+export class FileUtil implements IApiFileUtil {
+  /**
+   * @description 下载凭证工具
+   * @protected
+   * @memberof FileUtil
+   */
+  protected downloadTicketUtil = new DownloadTicketUtil();
+
+  /**
+   * @description 自定义文件上传请求头数据
+   * @protected
+   * @type {Record<string, string>}
+   * @memberof FileUtil
+   */
+  protected customUploadHeaders: Record<string, string> = {};
+
+  /**
+   * @description 设置文件上传请求头数据
+   * @param {Record<string, string>} args
+   * @memberof FileUtil
+   */
+  setUploadHeaders(args: Record<string, string>): void {
+    Object.assign(this.customUploadHeaders, args);
+  }
+
+  /**
+   * @description 获取是否启用下载凭证
+   * @protected
+   * @param {boolean} [enableDownloadTicket]
+   * @returns {*}  {boolean}
+   * @memberof FileUtil
+   */
+  protected getEnableDownloadTicket(enableDownloadTicket?: boolean): boolean {
+    let tempEnableDownloadTicket = ibiz.config.common.enableDownloadTicket;
+    if (enableDownloadTicket) {
+      tempEnableDownloadTicket = enableDownloadTicket;
+    }
+    return tempEnableDownloadTicket;
+  }
+
+  /**
+   * @description 获取文件上传请求头数据
+   * @returns {*}  {Record<string, string>}
+   * @memberof IFileUtil
+   */
+  getUploadHeaders(): Record<string, string> {
+    const uploadHeaders: Record<string, string> = {};
+    // 预定义请求头数据
+    const token = getAppCookie(CoreConst.TOKEN);
+    if (token) {
+      Object.assign(uploadHeaders, {
+        [`${ibiz.env.tokenHeader}Authorization`]: `${ibiz.env.tokenPrefix}Bearer ${token}`,
+      });
+    }
+    // 自定义请求头数据
+    if (
+      this.customUploadHeaders &&
+      Object.keys(this.customUploadHeaders).length > 0
+    ) {
+      Object.assign(uploadHeaders, {
+        ...this.customUploadHeaders,
+      });
+    }
+    return uploadHeaders;
+  }
+
+  /**
+   * 计算OSSCat参数
+   * @param url
+   * @param context
+   * @param OSSCatName
+   * @param enableNoAccess 若启用无权限模式则在文件存储目录后面拼接特殊字符'$'
+   * @param globalDownloadPrifix 是否启用全局下载文件前缀，启用则以global作为前缀
+   * @returns
+   */
+  protected calcOSSCatUrl(
+    url: string,
+    context: IContext,
+    OSSCatName?: string,
+    enableNoAccess: boolean = false,
+    globalDownloadPrifix: boolean = false,
+  ): string {
+    let targetUrl = `${ibiz.env.baseUrl}/${ibiz.env.appId}${url}`;
+    // 启用则以global作为前缀,仅下载识别此参数
+    if (globalDownloadPrifix) {
+      targetUrl = `/__APP__${url}`;
+    }
+    const app = ibiz.hub.getApp(context.srfappid);
+    const OSSCat =
+      OSSCatName ||
+      ibiz.env.defaultOSSCat ||
+      app.model.defaultOSSCat ||
+      app.model.userParam?.DefaultOSSCat;
+    targetUrl = targetUrl.replace(
+      '/{cat}',
+      OSSCat ? `/${OSSCat}${enableNoAccess ? '$' : ''}` : '',
+    );
+    return targetUrl;
+  }
+
+  /**
+   * @description 计算文件的上传路径和下载路径,下载路径文件id用%fileId%占位，替换即可;配置编辑器参数uploadParams和exportParams时，会像导航参数一样动态添加对应的参数到url上
+   * @param {IContext} context
+   * @param {IParams} params
+   * @param {IData} [data={}]
+   * @param {IApiFileUpDownExtraParams} [extraParams={}]
+   * @returns {*}  {{
+   *     uploadUrl: string;
+   *     downloadUrl: string;
+   *   }}
+   * @memberof FileUtil
+   */
+  calcFileUpDownUrl(
+    context: IContext,
+    params: IParams,
+    data: IData = {},
+    extraParams: IApiFileUpDownExtraParams = {},
+  ): {
+    uploadUrl: string;
+    downloadUrl: string;
+  } {
+    const {
+      uploadParams,
+      exportParams,
+      osscat: OSSCatName,
+      enableNoAccess,
+      globalDownloadPrifix,
+    } = extraParams;
+    // 计算文件上传路径
+    let uploadUrl = this.calcOSSCatUrl(
+      ibiz.env.uploadFileUrl,
+      context,
+      OSSCatName,
+      enableNoAccess,
+    );
+    // 计算文件下载路径
+    let downloadUrl = this.calcOSSCatUrl(
+      `${ibiz.env.downloadFileUrl}/%fileId%`,
+      context,
+      OSSCatName,
+      enableNoAccess,
+      globalDownloadPrifix,
+    );
+    let _uploadParams: IParams = {};
+    let _exportParams: IParams = {};
+    if (uploadParams) {
+      _uploadParams = convertNavData(uploadParams, data, params, context);
+    }
+    if (exportParams) {
+      _exportParams = convertNavData(exportParams, data, params, context);
+    }
+    uploadUrl += qs.stringify(_uploadParams, { addQueryPrefix: true });
+    downloadUrl += qs.stringify(_exportParams, { addQueryPrefix: true });
+    return { uploadUrl, downloadUrl };
+  }
+
+  /**
+   * @description 获取下载凭证
+   * @param {IApiContext} context
+   * @param {IParams} params
+   * @param {IData} data
+   * @param {({ fileId: string } & IData)} file
+   * @param {{ appEntityTag?: string; dataFieldTag?: string }} [downloadTicketParams]
+   * @returns {*}  {(Promise<IApiDownloadTicket | undefined>)}
+   * @memberof FileUtil
+   */
+  async getDownloadTicket(
+    context: IApiContext,
+    params: IParams,
+    data: IData,
+    file: { fileId: string } & IData,
+    downloadTicketParams: { appEntityTag?: string; dataFieldTag?: string } = {},
+  ): Promise<IApiDownloadTicket | undefined> {
+    return this.downloadTicketUtil.getDownloadTicket(
+      file.fileId,
+      context,
+      params,
+      data,
+      downloadTicketParams,
+    );
+  }
+
+  /**
+   * @description 设置下载票据
+   * @param {string} fileId
+   * @param {IData} downloadTicket
+   * @memberof FileUtil
+   */
+  public setDownloadTicket(fileId: string, downloadTicket: IData): void {
+    this.downloadTicketUtil.setDownloadTicket(
+      fileId,
+      new DownloadTicket(downloadTicket),
+    );
+  }
+
+  /**
+   * @description 请求url获取文件流，并用JS触发文件下载
+   * @param {string} url
+   * @param {string} [name]
+   * @param {({
+   *       context: IContext;
+   *       params: IParams;
+   *       data: IData;
+   *       file: { fileId: string } & IData;
+   *       extraParams?: IApiFileUpDownExtraParams;
+   *       downloadTicketParams?: { appEntityTag?: string; dataFieldTag?: string };
+   *     })} [downloadParams]
+   * @param {boolean} [enableDownloadTicket]
+   * @returns {*}  {Promise<void>}
+   * @memberof FileUtil
+   */
+  async fileDownload(
+    url: string,
+    name?: string,
+    downloadParams?: {
+      context: IContext;
+      params: IParams;
+      data: IData;
+      file: { fileId: string } & IData;
+      extraParams?: IApiFileUpDownExtraParams;
+      downloadTicketParams?: { appEntityTag?: string; dataFieldTag?: string };
+    },
+    enableDownloadTicket?: boolean,
+    enableNoAccess?: boolean,
+  ): Promise<void> {
+    const tempEnableDownloadTicket =
+      !enableNoAccess && this.getEnableDownloadTicket(enableDownloadTicket);
+    let tempDownloadUrl: string = url;
+    // 应用启用传入下载凭证且外部传入下载参数才去计算凭证
+    if (tempEnableDownloadTicket && downloadParams) {
+      const { context, params, data, file, extraParams, downloadTicketParams } =
+        downloadParams;
+      const { downloadUrl } = this.calcFileUpDownUrl(
+        context,
+        params,
+        data,
+        extraParams,
+      );
+      const downloadTicket = await this.getDownloadTicket(
+        context,
+        params,
+        data,
+        file,
+        downloadTicketParams,
+      );
+      if (!downloadTicket) {
+        throw new RuntimeError(
+          'runtime.utils.fileUtil.getDownloadTicketFailed',
+        );
+      }
+      tempDownloadUrl = downloadUrl.replace('%fileId%', downloadTicket.ticket);
+    }
+    // 发送get请求
+    const response = await ibiz.net.request(tempDownloadUrl, {
+      method: 'get',
+      responseType: 'blob',
+      baseURL: '', // 已经有baseURL了，这里无需再写
+    });
+
+    if (response.status !== 200) {
+      throw new RuntimeError(ibiz.i18n.t('runtime.platform.failedDownload'));
+    }
+    // 请求成功，后台返回的是一个文件流
+    if (!response.data) {
+      throw new RuntimeError(ibiz.i18n.t('runtime.platform.fileStreamData'));
+    } else {
+      // 获取文件名
+      let fileName = ibiz.util.file.getFileName(response);
+      // 外部传名称以外部为准，需要带文件后缀名
+      if (name) fileName = name;
+      downloadFileFromBlob(response.data as Blob, fileName);
+    }
+  }
+
+  /**
+   * @description 文件上传
+   * @param {string} uploadUrl
+   * @param {Blob} file
+   * @param {IData} headers
+   * @returns {*}  {Promise<IData>}
+   * @memberof FileUtil
+   */
+  async fileUpload(
+    uploadUrl: string,
+    file: Blob,
+    headers: IData,
+  ): Promise<IData> {
+    const formData = new FormData();
+    formData.append('file', file);
+    const res = await ibiz.net.axios({
+      url: uploadUrl,
+      method: 'post',
+      headers,
+      data: formData,
+    });
+    if (res.status !== 200) {
+      throw new RuntimeError(
+        ibiz.i18n.t('runtime.utils.fileUtil.fileUploadFailed'),
+      );
+    }
+    const result = res.data;
+    // 启用传入下载凭证成功后设置下载票据
+    if (ibiz.config.common.enableDownloadTicket && result.ticket) {
+      ibiz.util.file.setDownloadTicket(result.id, result.ticket);
+    }
+    return result;
+  }
+
+  /**
+   * @description 获取文件名
+   * @param {IHttpResponse<IData>} response
+   * @returns {*}  {string}
+   * @memberof FileUtil
+   */
+  getFileName(response: IHttpResponse<IData>): string {
+    let fileName = '';
+    const contentDisposition = response.headers['content-disposition'];
+    if (!contentDisposition) {
+      return fileName;
+    }
+    const disposition = qs.parse(contentDisposition, {
+      delimiter: ';',
+    });
+    if (disposition && disposition.filename) {
+      fileName = disposition.filename as string;
+    }
+    // 特殊处理返回的文件名带有双引号
+    if (fileName.startsWith('"') && fileName.endsWith('"')) {
+      fileName = fileName.substring(1, fileName.length - 1);
+    }
+    return fileName;
+  }
+
+  /**
+   * @description 选择文件并上传
+   * @param {IContext} context
+   * @param {IParams} params
+   * @param {IData} data
+   * @param {IData} [option={}]
+   * @returns {*}  {Promise<IData[]>}
+   * @memberof FileUtil
+   */
+  async chooseFileAndUpload(
+    context: IContext,
+    params: IParams,
+    data: IData,
+    option: IData = {},
+  ): Promise<IData[] | undefined> {
+    const { accept, multiple, showUploadManager, extraParams } = option;
+    const urls = ibiz.util.file.calcFileUpDownUrl(
+      context,
+      params,
+      data,
+      extraParams,
+    );
+    const files = await ibiz.util.file.chooseFile(accept, multiple);
+    if (!files) return;
+    let promises: IData[] = [];
+    const headers = this.getUploadHeaders();
+    if (showUploadManager) {
+      promises = await ibiz.notification.uploadManager({
+        uploadUrl: urls.uploadUrl,
+        files,
+        headers,
+      });
+      return promises;
+    }
+    for (let i = 0; i < files.length; i++) {
+      const promise = await ibiz.util.file.fileUpload(
+        urls.uploadUrl,
+        files[i],
+        headers,
+      );
+      promises.push(promise);
+    }
+    return Promise.all(promises);
+  }
+
+  /**
+   * @description 选择文件
+   * @param {string} [accept='']
+   * @param {boolean} [multiple=false]
+   * @returns {*}  {Promise<FileList>}
+   * @memberof FileUtil
+   */
+  chooseFile(
+    accept: string = '',
+    multiple: boolean = false,
+  ): Promise<FileList | undefined> {
+    return new Promise(resolve => {
+      // 创建 input 元素
+      let inputElement: HTMLInputElement | null =
+        document.createElement('input');
+      inputElement.type = 'file';
+      inputElement.accept = accept;
+      inputElement.multiple = multiple;
+      inputElement.webkitdirectory = false;
+      // 添加事件监听器，处理文件上传逻辑
+      inputElement.addEventListener(
+        'change',
+        (e: IData) => {
+          if (inputElement) {
+            document.body.removeChild(inputElement);
+            inputElement = null;
+          }
+          resolve(e.target.files);
+        },
+        { once: true },
+      );
+
+      // 将 input 元素添加到页面中
+      document.body.appendChild(inputElement);
+
+      // 执行文件上传操作
+      inputElement.click();
+
+      // 监听取消操作
+      window.addEventListener(
+        'focus',
+        () => {
+          // 确保执行在 change 之后
+          setTimeout(() => {
+            // 方法结束后销毁 input 元素
+            if (inputElement) {
+              document.body.removeChild(inputElement);
+              inputElement = null;
+            }
+            resolve(undefined);
+          }, 1000);
+        },
+        { once: true },
+      );
+    });
+  }
+
+  /**
+   * @description 通用请求文件方法，可自定义 responseType（默认获取Blob类型的文件流，responseType 的配置决定了请求服务时返回的文件数据格式）
+   * @param {string} url
+   * @param {XMLHttpRequestResponseType} [responseType]
+   * @param {({
+   *       context: IContext;
+   *       params: IParams;
+   *       data: IData;
+   *       file: { fileId: string } & IData;
+   *       extraParams?: IApiFileUpDownExtraParams;
+   *       downloadTicketParams?: { appEntityTag?: string; dataFieldTag?: string };
+   *     })} [downloadParams]
+   * @param {boolean} [enableDownloadTicket]
+   * @returns {*}  {Promise<IData>}
+   * @memberof FileUtil
+   */
+  async requestFile(
+    url: string,
+    responseType?: XMLHttpRequestResponseType,
+    downloadParams?: {
+      context: IContext;
+      params: IParams;
+      data: IData;
+      file: { fileId: string } & IData;
+      extraParams?: IApiFileUpDownExtraParams;
+      downloadTicketParams?: { appEntityTag?: string; dataFieldTag?: string };
+    },
+    enableDownloadTicket?: boolean,
+    enableNoAccess?: boolean,
+  ): Promise<IData> {
+    let tempDownloadUrl: string = url;
+    const tempEnableDownloadTicket =
+      !enableNoAccess && this.getEnableDownloadTicket(enableDownloadTicket);
+    // 如果启用了下载凭证，并且传入了下载参数，则拼接带凭证的下载地址
+    if (tempEnableDownloadTicket && downloadParams) {
+      const { context, params, data, file, extraParams, downloadTicketParams } =
+        downloadParams;
+      const { downloadUrl } = ibiz.util.file.calcFileUpDownUrl(
+        context,
+        params,
+        data,
+        extraParams,
+      );
+      const downloadTicket = await ibiz.util.file.getDownloadTicket(
+        context,
+        params,
+        data,
+        file,
+        downloadTicketParams,
+      );
+
+      if (!downloadTicket) {
+        throw new RuntimeError(
+          'runtime.utils.fileUtil.getDownloadTicketFailed',
+        );
+      }
+      tempDownloadUrl = downloadUrl.replace('%fileId%', downloadTicket.ticket);
+    }
+
+    // 发送请求
+    const response = await ibiz.net.request(tempDownloadUrl, {
+      method: 'get',
+      responseType: responseType || 'blob',
+      baseURL: '', // 已经有 baseURL，不需要再写
+    });
+
+    if (response.status !== 200) {
+      throw new RuntimeError(ibiz.i18n.t('runtime.platform.failedDownload'));
+    }
+
+    if (!response.data) {
+      throw new RuntimeError(ibiz.i18n.t('runtime.platform.fileStreamData'));
+    }
+
+    return response.data;
+  }
+
+  /**
+   * 图片压缩
+   * @param file      原始文件
+   * @param maxW      最大宽度（默认 1280）
+   * @param quality   压缩质量 0~1（默认 0.8）
+   * @returns Promise<File> 压缩后的新文件
+   */
+  compressImg = (
+    file: File,
+    maxW: number = 1280,
+    quality: number = 0.8,
+  ): Promise<File> => {
+    return new Promise((resolve, reject) => {
+      const img = new Image();
+      img.src = URL.createObjectURL(file);
+      img.onerror = (e: string | Event): void => reject(e);
+      img.onload = (): void => {
+        const { width: w, height: h } = img;
+
+        // 等比缩放
+        const scale = w > h ? maxW / w : maxW / h;
+        const cw = scale < 1 ? Math.round(w * scale) : w;
+        const ch = scale < 1 ? Math.round(h * scale) : h;
+
+        const canvas = document.createElement('canvas');
+        canvas.width = cw;
+        canvas.height = ch;
+        const ctx = canvas.getContext('2d')!;
+        ctx.drawImage(img, 0, 0, cw, ch);
+
+        canvas.toBlob(
+          blob => {
+            if (!blob) return reject();
+            // 把 blob 转成新 File（保留原名、类型）
+            const newFile = new File([blob], file.name, {
+              type: 'image/jpeg',
+              lastModified: Date.now(),
+            });
+            resolve(newFile);
+          },
+          'image/jpeg',
+          quality,
+        );
+      };
+    });
+  };
+
+  /**
+   * @description base64字符串转Blob对象
+   * @param {string} base64
+   * @returns {*}  {Blob}
+   * @memberof FileUtil
+   */
+  base64ToBlob(base64: string): Blob {
+    const binStr = atob(base64.split(',')[1]);
+    const len = binStr.length;
+    const arr = new Uint8Array(len);
+    for (let i = 0; i < len; i++) {
+      arr[i] = binStr.charCodeAt(i);
+    }
+    return new Blob([arr]);
+  }
+}

package/src/utils/file-util/index.ts

@@ -0,0 +1 @@
+export { FileUtil } from './file-util';

package/src/utils/handlebars/handlebars.ts

@@ -0,0 +1,82 @@
+import { IApiHandlebarsUtil } from '../../interface';
+import { installHelpers } from './helpers';
+
+/**
+ * @description handlebars 渲染工具类
+ * @export
+ * @class HandlebarsUtil
+ * @implements {IApiHandlebarsUtil}
+ */
+export class HandlebarsUtil implements IApiHandlebarsUtil {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  protected hsb: any;
+
+  /**
+   * @description 如果已经在请求中，则不再重复请求
+   * @protected
+   * @type {(Promise<unknown> | null)}
+   * @memberof HandlebarsUtil
+   */
+  protected p: Promise<unknown> | null = null;
+
+  /**
+   * @description handlebars 是否已经初始化
+   * @readonly
+   * @type {boolean}
+   * @memberof HandlebarsUtil
+   */
+  get isInit(): boolean {
+    return !!this.hsb;
+  }
+
+  /**
+   * @description 异步加载，初始化 handlebars
+   * @returns {*}  {Promise<unknown>}
+   * @memberof HandlebarsUtil
+   */
+  async init(): Promise<unknown> {
+    if (this.isInit) {
+      return;
+    }
+    if (this.p) {
+      return this.p;
+    }
+    this.p = import('handlebars');
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const module = (await this.p) as any;
+    this.hsb = module.default || module;
+    this.p = null;
+    installHelpers(this.hsb);
+    return this.hsb;
+  }
+
+  /**
+   * @description 异步绘制模板，返回渲染后的字符串
+   * @param {string} template
+   * @param {IData} data
+   * @returns {*}  {Promise<string>}
+   * @memberof HandlebarsUtil
+   */
+  async render(template: string, data: IData): Promise<string> {
+    if (!this.hsb) {
+      await this.init();
+    }
+    const tmp = this.hsb.compile(template);
+    return tmp(data);
+  }
+
+  /**
+   * @description 同步绘制模板，返回渲染后的字符串
+   * @param {string} template
+   * @param {IData} data
+   * @returns {*}  {string}
+   * @memberof HandlebarsUtil
+   */
+  syncRender(template: string, data: IData): string {
+    if (!this.hsb) {
+      throw new Error(ibiz.i18n.t('runtime.utils.handlebars.noInitHandlebars'));
+    }
+    const tmp = this.hsb.compile(template);
+    return tmp(data);
+  }
+}

package/src/utils/handlebars/helpers/abs/abs.ts

@@ -0,0 +1,20 @@
+import { HelperBase } from '../helper-base';
+
+/**
+ * 数字绝对值
+ *
+ * @description 用法 {{abs string }}。效果: 获取数值字符串的绝对值
+ * @export
+ * @class HelperAbs
+ * @extends {HelperBase}
+ */
+export class HelperAbs extends HelperBase {
+  constructor(hbs: IData) {
+    super(hbs, 'abs');
+  }
+
+  onExecute(str: string): string {
+    if (!str) return '';
+    return Math.abs(Number(str)).toString();
+  }
+}