jinbi-utils 1.0.19 → 1.0.21

package/src/file/index.ts

@@ -0,0 +1,319 @@
+/**
+ * 文件处理相关
+ * @packageDocumentation
+ * @module File
+ * @preferred
+ */
+
+import { isEmpty } from '../common';
+import { ceil } from '../number';
+
+export type FileSizeUnit =  'B' |'KB' | 'MB' | 'GB' | 'TB';
+
+export interface FileSizeObject {
+  size: number;
+  unit: FileSizeUnit;
+}
+/**
+ * 计算文件大小
+ #### 使用说明
+ ```
+ calcFileSize(100) 返回 { size: 100, unit: 'B' }
+ calcFileSize(1024) 返回 { size: 1, unit: 'KB' }
+ calcFileSize(1024, 'KB') 返回 { size: 1, unit: 'MB' }
+ calcFileSize(1126.4, 'mb') 返回 { size: 1.1, unit: 'GB' }
+ calcFileSize(Math.pow(1024, 2), 'kb') 返回 { size: 1, unit: 'GB' }
+ ```
+ * @param size 单位 k
+ * @returns number
+ */
+export function calcFileSize(size: number, unit: FileSizeUnit = 'B'): FileSizeObject {
+  const unitList: Array<FileSizeUnit> = ['B', 'KB', 'MB', 'GB', 'TB'];
+
+  let currentUnitIndex = unitList.indexOf(unit.toUpperCase() as FileSizeUnit);
+
+  currentUnitIndex = currentUnitIndex === -1 ? 0 : currentUnitIndex;
+
+  // todo 单位换算。
+  while (size >= 1024 && currentUnitIndex < unitList.length) {
+    size = size / 1024;
+    currentUnitIndex += 1;
+  }
+  return {
+    size,
+    unit: unitList[currentUnitIndex],
+  };
+}
+
+/**
+ * 文件大小转换
+ #### 使用说明
+ ```
+ fileSizeFormat('') 返回 -
+ fileSizeFormat('1024') 返回 1KB
+ fileSizeFormat('1024', 'KB') 返回 1MB
+ fileSizeFormat('2645', 'B') 返回 ceil(2645 / 1024, 2)MB
+ ```
+ * @param {string} str 字符串 单位k
+ */
+export function fileSizeFormat(str: string | number, unit: FileSizeUnit = 'B', defaultValue = '-') {
+  if (isEmpty(str)) {
+    return defaultValue;
+  }
+  const o = calcFileSize(parseFloat(str.toString()), unit);
+  return `${ceil(o.size, 2)}${o.unit}`;
+}
+
+/**
+ * base64转换为file
+ * dataurl base64图片
+ * */
+export function dataURLtoBlob(dataurl: string): Blob {
+  const mime = (dataurl.match(/:(.*?);/) as any)[1];
+  const bytes = window.atob(dataurl.split(',')[1]); // 去掉url的头，并转换为byte
+  // 处理异常,将ascii码小于0的转换为大于0
+  const ab = new ArrayBuffer(bytes.length);
+  const ia = new Uint8Array(ab);
+  for (let i = 0; i < bytes.length; i += 1) {
+    ia[i] = bytes.charCodeAt(i);
+  }
+  return new Blob([ab], { type: mime });
+}
+
+export function blobToDataURL(blob: Blob): any {
+  return new Promise((resolve, reject) => {
+    const reader = new FileReader();
+    reader.onload = (e) => {
+      if (!e || !e.target) {
+        reject(e);
+      } else {
+        resolve(e.target.result as string);
+      }
+    };
+    reader.onerror = (err) => {
+      reject(err);
+    };
+    reader.readAsDataURL(blob);
+  });
+}
+
+export interface CompressImgScaleCallback {
+  (w: number, h: number): number;
+}
+export interface CompressImgQualityCallback {
+  (fileSize: number, scale: number, w: number, h: number): number;
+}
+
+/**
+ * 压缩图片方法
+ * @param file 图片
+ * @param scaleCallback 宽高 压缩规则
+ * @param qualityCallback 质量 压缩规则
+ */
+export function compressImg(
+  file: File,
+  scaleCallback?: CompressImgScaleCallback,
+  qualityCallback?: CompressImgQualityCallback,
+): Promise<Blob> {
+  return new Promise((resolve, reject) => {
+    const fileSize = parseFloat((file.size / 1024 / 1024).toString());
+    const read = new FileReader();
+    read.onload = (e: ProgressEvent<FileReader>) => {
+      const img = new Image();
+      img.onload = () => {
+        // 读取图片宽高
+        const w = img.width;
+        const h = img.height;
+        // 生成canvas
+        const canvas = document.createElement('canvas');
+        const ctx = canvas.getContext('2d');
+
+        // 处理函数返回的不是 number & NaN 类型的情况
+        let scale = scaleCallback ? scaleCallback(w, h) : 1;
+        if (Number.isNaN(scale) || typeof scale !== 'number') {
+          scale = 1;
+        }
+        let quality = qualityCallback ? qualityCallback(fileSize, scale, w, h) : 1;
+        if (Number.isNaN(quality) || typeof quality !== 'number') {
+          quality = 1;
+        }
+
+        // 图片 缩放规则
+        if (ctx) {
+          const scaleW = parseInt((w * scale).toString(), 10);
+          const scaleH = parseInt((h * scale).toString(), 10);
+          // 创建属性节点
+          canvas.setAttribute('width', scaleW.toString());
+          canvas.setAttribute('height', scaleH.toString());
+          ctx.drawImage(img, 0, 0, scaleW, scaleH);
+        }
+        // 图片质量 压缩
+        const base64 = canvas.toDataURL(file.type, quality);
+
+        resolve(dataURLtoBlob(base64));
+      };
+      img.onerror = (evt: Event | string) => {
+        reject(evt);
+      };
+
+      if (e.target) {
+        img.src = e.target.result as string;
+      }
+    };
+
+    read.onerror = (e: ProgressEvent<FileReader>) => {
+      reject(e);
+    };
+    read.readAsDataURL(file);
+  });
+}
+
+export type Method =
+  | 'get' | 'GET'
+  | 'delete' | 'DELETE'
+  | 'head' | 'HEAD'
+  | 'options' | 'OPTIONS'
+  | 'post' | 'POST'
+  | 'put' | 'PUT'
+  | 'patch' | 'PATCH'
+  | 'link' | 'LINK'
+  | 'unlink' | 'UNLINK'
+
+export interface ExportByBlobParams {
+  /**
+   * 请求方式
+   */
+  method?: Method;
+  /**
+   * 接口地址
+   */
+  url: string;
+  /**
+   * post接口参数
+   */
+  data?: any;
+  /**
+   * get接口参数
+   */
+  params?: any;
+   /**
+   * 导出的文件名称
+   */
+  filename?: string;
+}
+
+
+export interface GenExportByBlobParams {
+/**
+ * axios 请求函数
+ */
+axiosRequest: any;
+/**
+ * 不使用 withCredentials 域名
+ */
+  notWithCredentials?: string[];
+}
+/**
+ * 生成导出函数
+ */
+export function genExportByBlob({
+  axiosRequest,
+  notWithCredentials = [],
+}) {
+  return function exportByBlob(config: ExportByBlobParams) {
+    let {
+      filename,
+    } = config;
+    const {
+      url,
+      data = {},
+      params = {},
+      method = 'post',
+     } = config;
+    return new Promise((resolve, reject) => {
+      axiosRequest({
+        method,
+        url,
+        data,
+        params,
+        responseType: 'blob',
+        config: {
+          withCredentials: notWithCredentials.some((str) => {
+            return !url.includes(str);
+          }),
+        },
+        // eslint-disable-next-line consistent-return
+      }).then(async (res) => {
+        const response = res?.data;
+        if (response.type === 'application/json') {
+          const reader = new FileReader();
+          reader.readAsText(response, 'utf-8');
+          reader.onload = () => {
+            let result: any = {};
+            try {
+              result = JSON.parse(reader.result as string);
+            } catch (e) {
+              result = response;
+            }
+            // Message.error((result && result.message) || '导出失败');
+            reject(result);
+          };
+        } else {
+          try {
+            const { headers } = res; // 下载后文件名
+            const contentDisposition = headers['content-disposition'];
+            const responseFilename = decodeURIComponent(contentDisposition.split(';')[1].split('filename=')[1]);
+            // 有传文件名称&不带后缀 使用服务端的文件拓展名
+            if (filename && !filename.includes('.')) {
+              const splitFileName = responseFilename.split('.');
+              const suffix = splitFileName[splitFileName.length - 1];
+              filename += `.${suffix}`;
+            } else if (!filename) {
+              filename = responseFilename;
+            }
+          } catch (e) {
+            // 默认名称
+            if (!filename) {
+              filename = 'download.xlsx';
+            }
+          }
+          const blob = new Blob([res.data]);
+          const downloadElement = document.createElement('a');
+          const href = await blobToDataURL(blob); // 创建下载的链接
+          downloadElement.href = href;
+          downloadElement.download = filename;
+          document.body.appendChild(downloadElement);
+          downloadElement.click(); // 点击下载
+          document.body.removeChild(downloadElement); // 下载完成移除元素
+          // window.URL.revokeObjectURL(href);
+          resolve(res);
+        }
+      }).catch((e: Error) => {
+        reject(e);
+      });
+    });
+  };
+}
+/**
+ * 将 base64 字符串转换为 File 或 Blob
+ * @param {string} base64 - 带有 data URI 的 base64 字符串
+ * @param {string} [filename] - 如果提供了，则返回 File；否则返回 Blob
+ * @returns {File|Blob}
+ */
+export async function base64ToFileOrBlob(base64, filename) {
+  const [meta, content] = base64.split(',')
+  const mime = meta.match(/:(.*?);/)[1]
+  const bstr = atob(content)
+  const len = bstr.length
+  const u8arr = new Uint8Array(len)
+
+  for (let i = 0; i < len; i++) {
+    u8arr[i] = bstr.charCodeAt(i)
+  }
+
+  if (filename) {
+    return new File([u8arr], filename, { type: mime })
+  } else {
+    return new Blob([u8arr], { type: mime })
+  }
+}