zmdms-utils 0.0.8 → 0.0.10

package/dist/es/common.d.ts

@@ -30,10 +30,32 @@ declare function parseQueryParams(url: string): {
  * @returns 转换过后的结果
  */
 declare function unescapeString(input: string): string;
+/**
+ * 将一些危险字符替换成后台能识别的字符
+ * @param input 需要转换的内容
+ * @returns 转换过后的结果
+ */
+declare function dangerouslyXss(input: string): string;
+/**
+ * 去除特殊字符。这个方法在附件预览的场景中有用到
+ */
+declare function specialString(input: string): string;
 /**
  * 将内容复制到粘贴板中
  * @param text 需要复制的内容
  */
 declare function copyToClipboard(text: string, callback?: any): void;
+/**
+ * 获取文件名中的后缀 返回文件名 + 后缀
+ * @param fileName 文件名
+ * @returns
+ */
+declare function getFileExtension(fileName: string): [string, string];
+/**
+ * 判断后缀是否符合图片格式
+ * @param extension 后缀
+ * @returns
+ */
+declare function isImageExtension(extension: string): boolean;
 
-export { addThousedSeparator, copyToClipboard, delay, emitter, parseQueryParams, unescapeString };
+export { addThousedSeparator, copyToClipboard, dangerouslyXss, delay, emitter, getFileExtension, isImageExtension, parseQueryParams, specialString, unescapeString };

package/dist/es/common.js

@@ -108,6 +108,35 @@ function unescapeString(input) {
         return escapedChars[match] || match;
     });
 }
+/**
+ * 将一些危险字符替换成后台能识别的字符
+ * @param input 需要转换的内容
+ * @returns 转换过后的结果
+ */
+function dangerouslyXss(input) {
+    if (!input) {
+        return "";
+    }
+    var escapedChars = {
+        lt: "",
+        gt: "",
+        nbsp: " ",
+        amp: "&",
+        quot: '"',
+    };
+    return input.replace(/&(amp|lt|gt|quot|nbsp);/g, function (match) {
+        return escapedChars[match] || match;
+    });
+}
+/**
+ * 去除特殊字符。这个方法在附件预览的场景中有用到
+ */
+function specialString(input) {
+    if (!input) {
+        return "";
+    }
+    return input.replace(/[~!@#$%^&*{}|]/g, "");
+}
 /**
  * 将内容复制到粘贴板中
  * @param text 需要复制的内容
@@ -139,5 +168,39 @@ function copyToClipboard(text, callback) {
         callback && callback(0);
     }
 }
+/**
+ * 获取文件名中的后缀 返回文件名 + 后缀
+ * @param fileName 文件名
+ * @returns
+ */
+function getFileExtension(fileName) {
+    if (!fileName) {
+        return ["", ""];
+    }
+    var lastPointIndex = fileName.lastIndexOf("."); // 从最后取点
+    var filePreName = fileName.substring(0, lastPointIndex); // 前面的名字
+    var fileExtension = fileName.substring(lastPointIndex + 1); // 后面的文件后缀
+    return [filePreName, fileExtension];
+}
+/**
+ * 判断后缀是否符合图片格式
+ * @param extension 后缀
+ * @returns
+ */
+function isImageExtension(extension) {
+    var imageExtensions = [
+        "jpg",
+        "png",
+        "jpeg",
+        "gif",
+        "tif",
+        "tga",
+        "bmp",
+        "dds",
+        "svg",
+        "webp",
+    ];
+    return imageExtensions.includes(extension.toLowerCase());
+}
 
-export { addThousedSeparator, copyToClipboard, delay, emitter, parseQueryParams, unescapeString };
+export { addThousedSeparator, copyToClipboard, dangerouslyXss, delay, emitter, getFileExtension, isImageExtension, parseQueryParams, specialString, unescapeString };

package/dist/es/file.d.ts

@@ -0,0 +1,90 @@
+/**
+ * 附件下载方法
+ * @param fileId 附件id
+ * @param fileName 附件名称
+ * @param options
+ * @param options.API_BASEURL {string} 接口请求的前缀地址 必传
+ * @param options.authToken {string} token 非必传
+ * @param options.waterMark {boolean | string} 是否添加水印 是否指定水印名称 非必传
+ * @param options.open boolean 是否不需要登录信息
+ */
+declare function downloadFile(fileId: string, fileName: string, options: IDownloadOptions): Promise<unknown>;
+/**
+ * 附件批量下载方法
+ * @param fileList 附件列表
+ * @param options.API_BASEURL {string} 接口请求的前缀地址 必传
+ * @param options.authToken {string} token 非必传
+ * @param options.waterMark {boolean | string} 是否添加水印 是否指定水印名称 非必传
+ * @param options.zipName string zip名字
+ * @returns
+ */
+declare function batchDownloadFiles(fileList: {
+    attachId: string;
+    attachName: string;
+    [props: string]: string;
+}[], options: IBatchDownloadOptions): Promise<unknown>;
+/**
+ * 附件预览。如果传入的附件是图片，那么实现批量预览
+ * @param fileId 附件id
+ * @param fileName 附件名称
+ * @param options
+ * @param options.API_BASEURL {string} 接口请求的前缀地址 必传
+ * @param options.authToken {string} token 非必传
+ * @param options.fileList { attachId: string, attachName: string ... }[]  附件列表。批量预览时有用
+ */
+declare function previewFile(fileId: string, fileName: string, options: IPreviewOptions): void;
+/**
+ * 生成附件下载链接
+ * @param fileId 附件id
+ * @param options
+ * @param options.API_BASEURL {string} 接口请求的前缀地址 非必传
+ * @param options.authToken {string} token 非必传
+ * @returns
+ */
+declare function createDownloadLink(fileId: string, options?: IDownloadLinkOptions): string;
+/**
+ * 生成原始图片路径
+ * @param fileId 附件id
+ * @param fileName 附件名称
+ * @param options
+ * @param options.API_BASEURL {string} 接口请求的前缀地址 非必传
+ * @param options.authToken {string} token 非必传
+ * @returns
+ */
+declare function createOriginalLink(fileId: string, fileName: string, options?: IOriginLinkOptions): string;
+declare function createThumbnailLink(fileId: string, fileName: string, options: IThumbnailLinkOptions): string;
+interface IOptions {
+    API_BASEURL: string;
+    authToken?: string;
+}
+interface IDownloadOptions extends IOptions {
+    /** 是否添加水印 */
+    waterMark?: boolean | string;
+    /** 是否开发不需要登录信息 */
+    open?: boolean;
+}
+interface IBatchDownloadOptions extends IOptions {
+    zipName: string;
+    /** 是否添加水印 */
+    waterMark?: boolean | string;
+}
+interface IDownloadLinkOptions extends Partial<IOptions> {
+    /** 不需要登录信息的附件下载链接 */
+    open?: boolean;
+}
+interface IPreviewOptions extends IOptions {
+    /** 附件列表 */
+    fileList?: {
+        attachId: string;
+        attachName: string;
+        [props: string]: string;
+    }[];
+}
+interface IOriginLinkOptions extends Partial<IOptions> {
+}
+interface IThumbnailLinkOptions extends Partial<IOptions> {
+    /** 缩放比例 */
+    scale?: number;
+}
+
+export { batchDownloadFiles, createDownloadLink, createOriginalLink, createThumbnailLink, downloadFile, previewFile };

package/dist/es/file.js

@@ -0,0 +1,222 @@
+import { getToken } from './auth.js';
+import { dangerouslyXss, specialString, getFileExtension, isImageExtension } from './common.js';
+
+/**
+ * 附件相关接口
+ */
+/**
+ * 附件下载方法
+ * @param fileId 附件id
+ * @param fileName 附件名称
+ * @param options
+ * @param options.API_BASEURL {string} 接口请求的前缀地址 必传
+ * @param options.authToken {string} token 非必传
+ * @param options.waterMark {boolean | string} 是否添加水印 是否指定水印名称 非必传
+ * @param options.open boolean 是否不需要登录信息
+ */
+function downloadFile(fileId, fileName, options) {
+    var API_BASEURL = options.API_BASEURL, authToken = options.authToken, _a = options.waterMark, waterMark = _a === void 0 ? true : _a, open = options.open;
+    return new Promise(function (resolve, reject) {
+        var xhr = new XMLHttpRequest();
+        // 获取请求基础数据
+        var _a = getBasicInfo(API_BASEURL, authToken), token = _a.token, apiBaseURL = _a.apiBaseURL;
+        if (open) {
+            xhr.open("GET", "".concat(apiBaseURL, "/api/zmdms-resource/oss/endpoint/public/download-file/").concat(fileId), true);
+        }
+        else {
+            xhr.open("GET", "".concat(apiBaseURL, "/api/zmdms-resource/oss/endpoint/download-file/").concat(fileId, "?Zmdms-Auth=bearer ").concat(token, "&addWaterMark=").concat(waterMark), true);
+        }
+        xhr.responseType = "blob";
+        xhr.onload = function () {
+            if (xhr.status === 200 || xhr.status === 201) {
+                var link = document.createElement("a");
+                var body = document.querySelector("body");
+                link.href = window.URL.createObjectURL(xhr.response);
+                link.download = dangerouslyXss(fileName);
+                // fix Firefox
+                link.style.display = "none";
+                body.appendChild(link);
+                link.click();
+                body.removeChild(link);
+                window.URL.revokeObjectURL(link.href);
+                resolve({ msg: "文件下载成功!" });
+            }
+            else {
+                reject();
+            }
+        };
+        xhr.onerror = function (err) {
+            reject(err);
+        };
+        xhr.send();
+    });
+}
+/**
+ * 附件批量下载方法
+ * @param fileList 附件列表
+ * @param options.API_BASEURL {string} 接口请求的前缀地址 必传
+ * @param options.authToken {string} token 非必传
+ * @param options.waterMark {boolean | string} 是否添加水印 是否指定水印名称 非必传
+ * @param options.zipName string zip名字
+ * @returns
+ */
+function batchDownloadFiles(fileList, options) {
+    var API_BASEURL = options.API_BASEURL, authToken = options.authToken, zipName = options.zipName, _a = options.waterMark, waterMark = _a === void 0 ? true : _a;
+    return new Promise(function (resolve, reject) {
+        var _a, _b, _c, _d, _e, _f;
+        var xhr = new XMLHttpRequest();
+        // 获取请求基础数据
+        var _g = getBasicInfo(API_BASEURL, authToken), token = _g.token, apiBaseURL = _g.apiBaseURL;
+        xhr.open("POST", "".concat(apiBaseURL, "/api/zmdms-resource/oss/endpoint/batch-download-file"), true);
+        xhr.responseType = "blob";
+        xhr.onload = function () {
+            if (xhr.status === 200 || xhr.status === 201) {
+                var link = document.createElement("a");
+                var body = document.querySelector("body");
+                link.href = window.URL.createObjectURL(xhr.response);
+                link.download = zipName;
+                // fix Firefox
+                link.style.display = "none";
+                body.appendChild(link);
+                link.click();
+                body.removeChild(link);
+                window.URL.revokeObjectURL(link.href);
+                resolve({ msg: "文件下载成功!" });
+            }
+            else {
+                reject();
+            }
+        };
+        xhr.onerror = function (err) {
+            reject(err);
+        };
+        xhr.setRequestHeader("Zmdms-Auth", token || "");
+        xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
+        var fileIds = (_c = (_b = (_a = fileList === null || fileList === void 0 ? void 0 : fileList.map) === null || _a === void 0 ? void 0 : _a.call(fileList, function (item) { return item.attachId; })) === null || _b === void 0 ? void 0 : _b.join) === null || _c === void 0 ? void 0 : _c.call(_b, ",");
+        var fileNames = (_f = (_e = (_d = fileList === null || fileList === void 0 ? void 0 : fileList.map) === null || _d === void 0 ? void 0 : _d.call(fileList, function (item) { return item.attachName; })) === null || _e === void 0 ? void 0 : _e.join) === null || _f === void 0 ? void 0 : _f.call(_e, ",");
+        xhr.send("attachIds=".concat(fileIds, "&fileNames=").concat(fileNames, "&zipName=").concat(zipName, "&addWaterMark=").concat(waterMark));
+    });
+}
+/**
+ * 附件预览。如果传入的附件是图片，那么实现批量预览
+ * @param fileId 附件id
+ * @param fileName 附件名称
+ * @param options
+ * @param options.API_BASEURL {string} 接口请求的前缀地址 必传
+ * @param options.authToken {string} token 非必传
+ * @param options.fileList { attachId: string, attachName: string ... }[]  附件列表。批量预览时有用
+ */
+function previewFile(fileId, fileName, options) {
+    var API_BASEURL = options.API_BASEURL, authToken = options.authToken, _a = options.fileList, fileList = _a === void 0 ? [] : _a;
+    // 获取请求基础数据
+    var _b = getBasicInfo(API_BASEURL, authToken), token = _b.token, apiBaseURL = _b.apiBaseURL;
+    // 处理附件名中的一些特殊字符
+    var previewFileName = dangerouslyXss(fileName);
+    try {
+        previewFileName = specialString(previewFileName);
+    }
+    catch (err) {
+        console.log(err);
+    }
+    // 获取文件后缀
+    var _c = getFileExtension(previewFileName), filePreName = _c[0], fileExtension = _c[1];
+    // 由于预览使用了文件名地址作为iframe的路径
+    // 如果文件名没变，文件内容改变。这样就会导致再次预览时 内容不会更新
+    // 所以将文件名 与 文件id组合来生成不同的文件名
+    previewFileName = "".concat(filePreName, "-").concat(fileId, ".").concat(fileExtension);
+    // 如果是图片 走批量预览接口
+    var isImage = isImageExtension(fileExtension);
+    if (isImage) {
+        var imgFiles = fileList.filter(function (item) {
+            var attachName = item.attachName, attachId = item.attachId;
+            var _a = getFileExtension(attachName), fileExtension = _a[1];
+            if (isImageExtension(fileExtension) && attachId !== fileId) {
+                return true;
+            }
+            return false;
+        });
+        var attachIds = imgFiles.map(function (item) { return item.attachId; }).join(",");
+        // 批量图片预览
+        window.open("".concat(apiBaseURL, "/picturesAttchPreview?attachIds=").concat(attachIds ? "".concat(fileId, ",").concat(attachIds) : fileId, "&Zmdms-Auth=bearer ").concat(token) + fileName
+            ? "&titleName=".concat(encodeURIComponent(previewFileName))
+            : "");
+    }
+    else {
+        // 普通预览
+        window.open("".concat(apiBaseURL, "/attchPreview?attachId=").concat(fileId, "&Zmdms-Auth=bearer ").concat(token, "&officePreviewType=pdf") +
+            fileName
+            ? "&titleName=".concat(encodeURIComponent(previewFileName))
+            : "");
+    }
+}
+/**
+ * 生成附件下载链接
+ * @param fileId 附件id
+ * @param options
+ * @param options.API_BASEURL {string} 接口请求的前缀地址 非必传
+ * @param options.authToken {string} token 非必传
+ * @returns
+ */
+function createDownloadLink(fileId, options) {
+    if (options === void 0) { options = {}; }
+    var API_BASEURL = options.API_BASEURL, authToken = options.authToken, open = options.open;
+    var _a = getBasicInfo(API_BASEURL || "", authToken), token = _a.token, apiBaseURL = _a.apiBaseURL;
+    if (open) {
+        return "".concat(apiBaseURL, "/api/zmdms-resource/oss/endpoint/public/download-file/").concat(fileId);
+    }
+    return "".concat(apiBaseURL, "/api/zmdms-resource/oss/endpoint/download-file/").concat(fileId, "?Zmdms-Auth=bearer ").concat(token);
+}
+/**
+ * 生成原始图片路径
+ * @param fileId 附件id
+ * @param fileName 附件名称
+ * @param options
+ * @param options.API_BASEURL {string} 接口请求的前缀地址 非必传
+ * @param options.authToken {string} token 非必传
+ * @returns
+ */
+function createOriginalLink(fileId, fileName, options) {
+    if (options === void 0) { options = {}; }
+    var API_BASEURL = options.API_BASEURL, authToken = options.authToken;
+    var _a = getBasicInfo(API_BASEURL || "", authToken), token = _a.token, apiBaseURL = _a.apiBaseURL;
+    // 处理附件名中的一些特殊字符
+    var previewFileName = dangerouslyXss(fileName);
+    try {
+        previewFileName = specialString(previewFileName);
+    }
+    catch (err) {
+        console.log(err);
+    }
+    // 获取文件后缀
+    var _b = getFileExtension(previewFileName), filePreName = _b[0], fileExtension = _b[1];
+    // 由于预览使用了文件名地址作为iframe的路径
+    // 如果文件名没变，文件内容改变。这样就会导致再次预览时 内容不会更新
+    // 所以将文件名 与 文件id组合来生成不同的文件名
+    previewFileName = "".concat(filePreName, "-").concat(fileId, ".").concat(fileExtension);
+    return "".concat(apiBaseURL, "/attchPreview?attachId=").concat(fileId, "&Zmdms-Auth=bearer ").concat(token, "&officePreviewType=pdf") +
+        fileName
+        ? "&titleName=".concat(encodeURIComponent(previewFileName))
+        : "";
+}
+function createThumbnailLink(fileId, fileName, options) {
+    var API_BASEURL = options.API_BASEURL, authToken = options.authToken, _a = options.scale, scale = _a === void 0 ? 0.5 : _a;
+    var _b = getBasicInfo(API_BASEURL || "", authToken), token = _b.token, apiBaseURL = _b.apiBaseURL;
+    return "".concat(apiBaseURL, "/api/zmdms-resource/oss/endpoint/thumbnail/").concat(fileId, "?scale=").concat(scale, "&Zmdms-Auth=bearer ").concat(token);
+}
+/**
+ * 获取基础数据
+ * @param baseURL 基础URL
+ * @param token token
+ * @returns
+ */
+function getBasicInfo(baseURL, token) {
+    var _a;
+    return {
+        token: token || getToken(),
+        apiBaseURL: ((_a = baseURL === null || baseURL === void 0 ? void 0 : baseURL.endsWith) === null || _a === void 0 ? void 0 : _a.call(baseURL, "/"))
+            ? baseURL.slice(0, baseURL.length - 1)
+            : baseURL,
+    };
+}
+
+export { batchDownloadFiles, createDownloadLink, createOriginalLink, createThumbnailLink, downloadFile, previewFile };

package/dist/es/request.d.ts

@@ -48,6 +48,8 @@ interface IOtherOptions {
     crypto?: Crypto;
     isTimeoutConfirm?: boolean;
     isTimeoutConfirmStr?: string;
+    interceptorsRequestHandle?: () => void;
+    interceptorsResponseHandle?: () => void;
 }
 
 export { AxiosRequest, IOptions, IOtherOptions };

package/dist/es/request.js

@@ -41,6 +41,10 @@ var AxiosRequest = /** @class */ (function () {
     };
     // 拦截请求
     AxiosRequest.prototype.interceptorsRequest = function () {
+        if (this.otherOptions.interceptorsRequestHandle) {
+            this.otherOptions.interceptorsRequestHandle();
+            return;
+        }
         axios.interceptors.request.use(function (config) {
             return config;
         }, function (error) {
@@ -50,6 +54,10 @@ var AxiosRequest = /** @class */ (function () {
     // 拦截响应
     AxiosRequest.prototype.interceptorsResponse = function () {
         var _this = this;
+        if (this.otherOptions.interceptorsResponseHandle) {
+            this.otherOptions.interceptorsResponseHandle();
+            return;
+        }
         axios.interceptors.response.use(function (response) {
             var _a;
             // console.log(response);

package/dist/es/test.js

@@ -0,0 +1,54 @@
+function unescapeString(input) {
+  if (!input) {
+    return "";
+  }
+
+  const escapedChars = {
+    "&": "&",
+    "&lt;": "<",
+    "&gt;": ">",
+    "&quot;": '"',
+    "&#039;": "'",
+  };
+
+  return input.replace(/&(amp|lt|gt|quot|#039);/g, (match) => {
+    return escapedChars[match] || match;
+  });
+}
+
+function dangerouslySetXss(input) {
+  if (!input) {
+    return "";
+  }
+  const escapedChars = {
+    "&lt;": "",
+    "&gt;": "",
+    "&nbsp;": " ",
+    "&amp;": "&",
+    "&quot;": '"',
+  };
+
+  return input.replace(/&(amp|lt|gt|quot|nbsp);/g, (match) => {
+    return escapedChars[match] || match;
+  });
+}
+
+function dangerouslySetXss1(str) {
+  if (!str) {
+    return str;
+  }
+  try {
+    const arrEntities = { lt: "", gt: "", nbsp: " ", amp: "&", quot: '"' };
+    return str?.replace?.(/&(lt|gt|nbsp|amp|quot);/gi, function (all, t) {
+      return arrEntities[t];
+    });
+  } catch (err) {
+    return str;
+  }
+}
+
+console.log(unescapeString("&amp;&amp;&amp;啊你"));
+
+console.log(dangerouslySetXss("&amp;&amp;&amp;啊你"));
+
+console.log(dangerouslySetXss1("&amp;&amp;&amp;啊你"));

package/dist/index.d.ts

@@ -5,7 +5,8 @@ export { getToken, removeToken, setToken } from './es/auth.js';
 export { AxiosRequest, IOptions, IOtherOptions } from './es/request.js';
 export { getBaseUrl } from './es/baseUrl.js';
 export { Crypto, md5 } from './es/crypto.js';
-export { addThousedSeparator, copyToClipboard, delay, emitter, parseQueryParams, unescapeString } from './es/common.js';
+export { addThousedSeparator, copyToClipboard, dangerouslyXss, delay, emitter, getFileExtension, isImageExtension, parseQueryParams, specialString, unescapeString } from './es/common.js';
 export { divide, exactRound, formatUnit, minus, plus, times } from './es/math.js';
 export { validatePassword } from './es/passwordValidate.js';
 export { emailValidate, idCardValidate, morePhoneValidate, phoneValidate, strLenValidate } from './es/validate.js';
+export { batchDownloadFiles, createDownloadLink, createOriginalLink, createThumbnailLink, downloadFile, previewFile } from './es/file.js';

package/dist/index.js

@@ -5,7 +5,8 @@ export { getToken, removeToken, setToken } from './es/auth.js';
 export { AxiosRequest } from './es/request.js';
 export { getBaseUrl } from './es/baseUrl.js';
 export { Crypto, md5 } from './es/crypto.js';
-export { addThousedSeparator, copyToClipboard, delay, emitter, parseQueryParams, unescapeString } from './es/common.js';
+export { addThousedSeparator, copyToClipboard, dangerouslyXss, delay, emitter, getFileExtension, isImageExtension, parseQueryParams, specialString, unescapeString } from './es/common.js';
 export { divide, exactRound, formatUnit, minus, plus, times } from './es/math.js';
 export { validatePassword } from './es/passwordValidate.js';
 export { emailValidate, idCardValidate, morePhoneValidate, phoneValidate, strLenValidate } from './es/validate.js';
+export { batchDownloadFiles, createDownloadLink, createOriginalLink, createThumbnailLink, downloadFile, previewFile } from './es/file.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zmdms-utils",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.js",

package/src/common.ts

@@ -115,6 +115,38 @@ export function unescapeString(input: string): string {
   });
 }
 
+/**
+ * 将一些危险字符替换成后台能识别的字符
+ * @param input 需要转换的内容
+ * @returns 转换过后的结果
+ */
+export function dangerouslyXss(input: string): string {
+  if (!input) {
+    return "";
+  }
+  const escapedChars: { [key: string]: string } = {
+    lt: "",
+    gt: "",
+    nbsp: " ",
+    amp: "&",
+    quot: '"',
+  };
+
+  return input.replace(/&(amp|lt|gt|quot|nbsp);/g, (match) => {
+    return escapedChars[match] || match;
+  });
+}
+
+/**
+ * 去除特殊字符。这个方法在附件预览的场景中有用到
+ */
+export function specialString(input: string): string {
+  if (!input) {
+    return "";
+  }
+  return input.replace(/[~!@#$%^&*{}|]/g, "");
+}
+
 /**
  * 将内容复制到粘贴板中
  * @param text 需要复制的内容
@@ -142,3 +174,40 @@ export function copyToClipboard(text: string, callback?: any) {
     callback && callback(0);
   }
 }
+
+/**
+ * 获取文件名中的后缀 返回文件名 + 后缀
+ * @param fileName 文件名
+ * @returns
+ */
+export function getFileExtension(fileName: string): [string, string] {
+  if (!fileName) {
+    return ["", ""];
+  }
+  const lastPointIndex = fileName.lastIndexOf("."); // 从最后取点
+  const filePreName = fileName.substring(0, lastPointIndex); // 前面的名字
+  const fileExtension = fileName.substring(lastPointIndex + 1); // 后面的文件后缀
+  return [filePreName, fileExtension];
+}
+
+/**
+ * 判断后缀是否符合图片格式
+ * @param extension 后缀
+ * @returns
+ */
+export function isImageExtension(extension: string): boolean {
+  const imageExtensions = [
+    "jpg",
+    "png",
+    "jpeg",
+    "gif",
+    "tif",
+    "tga",
+    "bmp",
+    "dds",
+    "svg",
+    "webp",
+  ];
+
+  return imageExtensions.includes(extension.toLowerCase());
+}

package/src/file.ts

@@ -0,0 +1,310 @@
+/**
+ * 附件相关接口
+ */
+import { getToken } from "./auth";
+import {
+  dangerouslyXss,
+  specialString,
+  getFileExtension,
+  isImageExtension,
+} from "./common";
+
+/**
+ * 附件下载方法
+ * @param fileId 附件id
+ * @param fileName 附件名称
+ * @param options
+ * @param options.API_BASEURL {string} 接口请求的前缀地址 必传
+ * @param options.authToken {string} token 非必传
+ * @param options.waterMark {boolean | string} 是否添加水印 是否指定水印名称 非必传
+ * @param options.open boolean 是否不需要登录信息
+ */
+export function downloadFile(
+  fileId: string,
+  fileName: string,
+  options: IDownloadOptions
+) {
+  const { API_BASEURL, authToken, waterMark = true, open } = options;
+  return new Promise((resolve, reject) => {
+    const xhr = new XMLHttpRequest();
+    // 获取请求基础数据
+    const { token, apiBaseURL } = getBasicInfo(API_BASEURL, authToken);
+    if (open) {
+      xhr.open(
+        "GET",
+        `${apiBaseURL}/api/zmdms-resource/oss/endpoint/public/download-file/${fileId}`,
+        true
+      );
+    } else {
+      xhr.open(
+        "GET",
+        `${apiBaseURL}/api/zmdms-resource/oss/endpoint/download-file/${fileId}?Zmdms-Auth=bearer ${token}&addWaterMark=${waterMark}`,
+        true
+      );
+    }
+    xhr.responseType = "blob";
+    xhr.onload = function () {
+      if (xhr.status === 200 || xhr.status === 201) {
+        const link = document.createElement("a");
+        const body: any = document.querySelector("body");
+
+        link.href = window.URL.createObjectURL(xhr.response);
+        link.download = dangerouslyXss(fileName);
+
+        // fix Firefox
+        link.style.display = "none";
+        body.appendChild(link);
+
+        link.click();
+        body.removeChild(link);
+
+        window.URL.revokeObjectURL(link.href);
+
+        resolve({ msg: "文件下载成功!" });
+      } else {
+        reject();
+      }
+    };
+    xhr.onerror = function (err) {
+      reject(err);
+    };
+    xhr.send();
+  });
+}
+
+/**
+ * 附件批量下载方法
+ * @param fileList 附件列表
+ * @param options.API_BASEURL {string} 接口请求的前缀地址 必传
+ * @param options.authToken {string} token 非必传
+ * @param options.waterMark {boolean | string} 是否添加水印 是否指定水印名称 非必传
+ * @param options.zipName string zip名字
+ * @returns
+ */
+export function batchDownloadFiles(
+  fileList: {
+    attachId: string;
+    attachName: string;
+    [props: string]: string;
+  }[],
+  options: IBatchDownloadOptions
+) {
+  const { API_BASEURL, authToken, zipName, waterMark = true } = options;
+  return new Promise((resolve, reject) => {
+    const xhr = new XMLHttpRequest();
+    // 获取请求基础数据
+    const { token, apiBaseURL } = getBasicInfo(API_BASEURL, authToken);
+    xhr.open(
+      "POST",
+      `${apiBaseURL}/api/zmdms-resource/oss/endpoint/batch-download-file`,
+      true
+    );
+    xhr.responseType = "blob";
+    xhr.onload = function () {
+      if (xhr.status === 200 || xhr.status === 201) {
+        const link = document.createElement("a");
+        const body: any = document.querySelector("body");
+
+        link.href = window.URL.createObjectURL(xhr.response);
+        link.download = zipName;
+
+        // fix Firefox
+        link.style.display = "none";
+        body.appendChild(link);
+
+        link.click();
+        body.removeChild(link);
+
+        window.URL.revokeObjectURL(link.href);
+
+        resolve({ msg: "文件下载成功!" });
+      } else {
+        reject();
+      }
+    };
+    xhr.onerror = function (err) {
+      reject(err);
+    };
+    xhr.setRequestHeader("Zmdms-Auth", token || "");
+    xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
+    const fileIds = fileList?.map?.((item) => item.attachId)?.join?.(",");
+    const fileNames = fileList?.map?.((item) => item.attachName)?.join?.(",");
+    xhr.send(
+      `attachIds=${fileIds}&fileNames=${fileNames}&zipName=${zipName}&addWaterMark=${waterMark}`
+    );
+  });
+}
+
+/**
+ * 附件预览。如果传入的附件是图片，那么实现批量预览
+ * @param fileId 附件id
+ * @param fileName 附件名称
+ * @param options
+ * @param options.API_BASEURL {string} 接口请求的前缀地址 必传
+ * @param options.authToken {string} token 非必传
+ * @param options.fileList { attachId: string, attachName: string ... }[]  附件列表。批量预览时有用
+ */
+export function previewFile(
+  fileId: string,
+  fileName: string,
+  options: IPreviewOptions
+) {
+  const { API_BASEURL, authToken, fileList = [] } = options;
+  // 获取请求基础数据
+  const { token, apiBaseURL } = getBasicInfo(API_BASEURL, authToken);
+  // 处理附件名中的一些特殊字符
+  let previewFileName = dangerouslyXss(fileName);
+  try {
+    previewFileName = specialString(previewFileName);
+  } catch (err) {
+    console.log(err);
+  }
+  // 获取文件后缀
+  const [filePreName, fileExtension] = getFileExtension(previewFileName);
+  // 由于预览使用了文件名地址作为iframe的路径
+  // 如果文件名没变，文件内容改变。这样就会导致再次预览时 内容不会更新
+  // 所以将文件名 与 文件id组合来生成不同的文件名
+  previewFileName = `${filePreName}-${fileId}.${fileExtension}`;
+  // 如果是图片 走批量预览接口
+  const isImage = isImageExtension(fileExtension);
+  if (isImage) {
+    const imgFiles = fileList.filter((item) => {
+      const { attachName, attachId } = item;
+      const [, fileExtension] = getFileExtension(attachName);
+      if (isImageExtension(fileExtension) && attachId !== fileId) {
+        return true;
+      }
+      return false;
+    });
+    let attachIds = imgFiles.map((item) => item.attachId).join(",");
+    // 批量图片预览
+    window.open(
+      `${apiBaseURL}/picturesAttchPreview?attachIds=${
+        attachIds ? `${fileId},${attachIds}` : fileId
+      }&Zmdms-Auth=bearer ${token}` + fileName
+        ? `&titleName=${encodeURIComponent(previewFileName)}`
+        : ""
+    );
+  } else {
+    // 普通预览
+    window.open(
+      `${apiBaseURL}/attchPreview?attachId=${fileId}&Zmdms-Auth=bearer ${token}&officePreviewType=pdf` +
+        fileName
+        ? `&titleName=${encodeURIComponent(previewFileName)}`
+        : ""
+    );
+  }
+}
+
+/**
+ * 生成附件下载链接
+ * @param fileId 附件id
+ * @param options
+ * @param options.API_BASEURL {string} 接口请求的前缀地址 非必传
+ * @param options.authToken {string} token 非必传
+ * @returns
+ */
+export function createDownloadLink(
+  fileId: string,
+  options: IDownloadLinkOptions = {}
+) {
+  const { API_BASEURL, authToken, open } = options;
+  const { token, apiBaseURL } = getBasicInfo(API_BASEURL || "", authToken);
+  if (open) {
+    return `${apiBaseURL}/api/zmdms-resource/oss/endpoint/public/download-file/${fileId}`;
+  }
+  return `${apiBaseURL}/api/zmdms-resource/oss/endpoint/download-file/${fileId}?Zmdms-Auth=bearer ${token}`;
+}
+
+/**
+ * 生成原始图片路径
+ * @param fileId 附件id
+ * @param fileName 附件名称
+ * @param options
+ * @param options.API_BASEURL {string} 接口请求的前缀地址 非必传
+ * @param options.authToken {string} token 非必传
+ * @returns
+ */
+export function createOriginalLink(
+  fileId: string,
+  fileName: string,
+  options: IOriginLinkOptions = {}
+) {
+  const { API_BASEURL, authToken } = options;
+  const { token, apiBaseURL } = getBasicInfo(API_BASEURL || "", authToken);
+  // 处理附件名中的一些特殊字符
+  let previewFileName = dangerouslyXss(fileName);
+  try {
+    previewFileName = specialString(previewFileName);
+  } catch (err) {
+    console.log(err);
+  }
+  // 获取文件后缀
+  const [filePreName, fileExtension] = getFileExtension(previewFileName);
+  // 由于预览使用了文件名地址作为iframe的路径
+  // 如果文件名没变，文件内容改变。这样就会导致再次预览时 内容不会更新
+  // 所以将文件名 与 文件id组合来生成不同的文件名
+  previewFileName = `${filePreName}-${fileId}.${fileExtension}`;
+  return `${apiBaseURL}/attchPreview?attachId=${fileId}&Zmdms-Auth=bearer ${token}&officePreviewType=pdf` +
+    fileName
+    ? `&titleName=${encodeURIComponent(previewFileName)}`
+    : "";
+}
+
+export function createThumbnailLink(
+  fileId: string,
+  fileName: string,
+  options: IThumbnailLinkOptions
+) {
+  const { API_BASEURL, authToken, scale = 0.5 } = options;
+  const { token, apiBaseURL } = getBasicInfo(API_BASEURL || "", authToken);
+  return `${apiBaseURL}/api/zmdms-resource/oss/endpoint/thumbnail/${fileId}?scale=${scale}&Zmdms-Auth=bearer ${token}`;
+}
+
+/**
+ * 获取基础数据
+ * @param baseURL 基础URL
+ * @param token token
+ * @returns
+ */
+function getBasicInfo(baseURL: string, token?: string) {
+  return {
+    token: token || getToken(),
+    apiBaseURL: baseURL?.endsWith?.("/")
+      ? baseURL.slice(0, baseURL.length - 1)
+      : baseURL,
+  };
+}
+
+interface IOptions {
+  API_BASEURL: string;
+  authToken?: string;
+}
+interface IDownloadOptions extends IOptions {
+  /** 是否添加水印 */
+  waterMark?: boolean | string;
+  /** 是否开发不需要登录信息 */
+  open?: boolean;
+}
+interface IBatchDownloadOptions extends IOptions {
+  zipName: string;
+  /** 是否添加水印 */
+  waterMark?: boolean | string;
+}
+interface IDownloadLinkOptions extends Partial<IOptions> {
+  /** 不需要登录信息的附件下载链接 */
+  open?: boolean;
+}
+interface IPreviewOptions extends IOptions {
+  /** 附件列表 */
+  fileList?: {
+    attachId: string;
+    attachName: string;
+    [props: string]: string;
+  }[];
+}
+interface IOriginLinkOptions extends Partial<IOptions> {}
+interface IThumbnailLinkOptions extends Partial<IOptions> {
+  /** 缩放比例 */
+  scale?: number;
+}

package/src/index.ts

@@ -12,6 +12,10 @@ export {
   parseQueryParams,
   unescapeString,
   copyToClipboard,
+  getFileExtension,
+  isImageExtension,
+  dangerouslyXss,
+  specialString,
 } from "./common";
 export { plus, minus, times, divide, exactRound, formatUnit } from "./math";
 export { validatePassword } from "./passwordValidate";
@@ -22,3 +26,12 @@ export {
   idCardValidate,
   emailValidate,
 } from "./validate";
+/** 附件预览相关 */
+export {
+  downloadFile,
+  batchDownloadFiles,
+  previewFile,
+  createDownloadLink,
+  createOriginalLink,
+  createThumbnailLink,
+} from "./file";

package/src/request.ts

@@ -65,6 +65,10 @@ export class AxiosRequest {
 
   // 拦截请求
   private interceptorsRequest() {
+    if (this.otherOptions.interceptorsRequestHandle) {
+      this.otherOptions.interceptorsRequestHandle();
+      return;
+    }
     axios.interceptors.request.use(
       (config) => {
         return config;
@@ -77,6 +81,10 @@ export class AxiosRequest {
 
   // 拦截响应
   private interceptorsResponse() {
+    if (this.otherOptions.interceptorsResponseHandle) {
+      this.otherOptions.interceptorsResponseHandle();
+      return;
+    }
     axios.interceptors.response.use(
       (response) => {
         // console.log(response);
@@ -326,4 +334,8 @@ export interface IOtherOptions {
   isTimeoutConfirm?: boolean;
   // 超时弹框提示内容
   isTimeoutConfirmStr?: string;
+  // 拦截器自定义
+  interceptorsRequestHandle?: () => void;
+  // 响应器自定义
+  interceptorsResponseHandle?: () => void;
 }

package/src/test.js

@@ -0,0 +1,54 @@
+function unescapeString(input) {
+  if (!input) {
+    return "";
+  }
+
+  const escapedChars = {
+    "&": "&",
+    "&lt;": "<",
+    "&gt;": ">",
+    "&quot;": '"',
+    "&#039;": "'",
+  };
+
+  return input.replace(/&(amp|lt|gt|quot|#039);/g, (match) => {
+    return escapedChars[match] || match;
+  });
+}
+
+function dangerouslySetXss(input) {
+  if (!input) {
+    return "";
+  }
+  const escapedChars = {
+    "&lt;": "",
+    "&gt;": "",
+    "&nbsp;": " ",
+    "&amp;": "&",
+    "&quot;": '"',
+  };
+
+  return input.replace(/&(amp|lt|gt|quot|nbsp);/g, (match) => {
+    return escapedChars[match] || match;
+  });
+}
+
+function dangerouslySetXss1(str) {
+  if (!str) {
+    return str;
+  }
+  try {
+    const arrEntities = { lt: "", gt: "", nbsp: " ", amp: "&", quot: '"' };
+    return str?.replace?.(/&(lt|gt|nbsp|amp|quot);/gi, function (all, t) {
+      return arrEntities[t];
+    });
+  } catch (err) {
+    return str;
+  }
+}
+
+console.log(unescapeString("&amp;&amp;&amp;啊你"));
+
+console.log(dangerouslySetXss("&amp;&amp;&amp;啊你"));
+
+console.log(dangerouslySetXss1("&amp;&amp;&amp;啊你"));