@hzab/utils 1.1.1 → 1.1.3

package/src/upload/OfflineUpload.ts

@@ -1,341 +1,342 @@
-import dayjs from "dayjs";
-import { Axios, AxiosRequestConfig } from "axios";
-
-import { axios } from "@hzab/data-model";
-
-import { formatDirStr, mergeDirStr, getFileNameByFileObj } from "./uploadUtils";
-
-/**
- * 获取上传相关配置入参
- */
-export interface IGetSignatureOpt {
-  /**
-   * 配置接口地址
-   */
-  serverUrl?: string;
-  /**
-   * axios 实例
-   */
-  axios?: Axios;
-  /**
-   * axios 配置
-   */
-  axiosConf?: AxiosRequestConfig;
-  /**
-   * 请求入参
-   */
-  params?: {
-    path?: string;
-  };
-}
-
-export interface IOfflineUploadProps {
-  /**
-   * axios 实例
-   */
-  axios?: Axios;
-  /**
-   * axios 配置
-   */
-  axiosConf?: AxiosRequestConfig;
-  /**
-   * 配置接口地址
-   */
-  serverUrl?: string;
-  /**
-   * 获取配置接口请求入参
-   */
-  signatureParams?: {
-    path?: string;
-  };
-}
-
-/**
- * 文件上传入参
- */
-export interface IUploadOpt {
-  /**
-   * 配置接口地址
-   */
-  serverUrl?: string;
-  /**
-   * 是否开启 Hash 命名
-   */
-  useHashName?: boolean;
-  /**
-   * 文件上传接口地址
-   */
-  uploadUrl?: string;
-  /**
-   * 获取配置接口请求入参
-   */
-  params?: {
-    path?: string;
-    // 兼容 老数据
-    dir?: string;
-  };
-  /**
-   * 文件上传请求入参
-   */
-  ossParams?: {
-    path?: string;
-    // 兼容 老数据
-    dir?: string;
-  };
-  /**
-   * axios 实例
-   */
-  axios?: Axios;
-  /**
-   * axios 配置
-   */
-  axiosConf?: AxiosRequestConfig;
-}
-
-/**
- * 获取上传配置
- * @param opt
- * @returns
- */
-export function getSignature(opt: IGetSignatureOpt = {}) {
-  const { serverUrl = "/api/v1/upload/init" } = opt;
-  // 减 10 秒，避免发起请求时 刚好过期的情况
-  const { axios: _ax = axios, params = {}, axiosConf } = opt;
-  if (
-    window._$offlineSignatureRes &&
-    window._$offlineSignatureRes.data &&
-    serverUrl + JSON.stringify(params) === window._$offlineSignatureRes.serverUrlParams &&
-    dayjs().valueOf() - window._$offlineSignatureRes.__saveTime < window._$offlineSignatureRes.expireTimeMilles - 10000
-  ) {
-    return Promise.resolve(window._$offlineSignatureRes.data);
-  }
-  // 处理 path 格式，必须为非 / 开头， /  结尾。如： test/
-  params.path = formatDirStr(params.path);
-
-  return _ax
-    .post(
-      serverUrl,
-      {
-        ...params,
-      },
-      {
-        ...axiosConf,
-      },
-    )
-    .then((res) => {
-      if (res?.data?.code === 500) {
-        return Promise.reject(res.data);
-      }
-      if (res?.data?.code === 200) {
-        window._$offlineSignatureRes = {
-          data: res?.data?.data,
-        };
-        if (window._$offlineSignatureRes) {
-          window._$offlineSignatureRes.__saveTime = dayjs().valueOf();
-          window._$offlineSignatureRes.serverUrlParams = serverUrl + JSON.stringify(params);
-        }
-        return window._$offlineSignatureRes.data;
-      }
-    });
-}
-
-export interface IGetPreviewUrlsOpt {
-  previewUrl?: string;
-  params?: Object;
-  axios?: Axios;
-  axiosConf?: AxiosRequestConfig;
-}
-
-/**
- * 获取预览地址-批量
- * @param urlList
- * @param opt
- * @returns
- */
-export const getPreviewUrls = function (urlList, opt: IGetPreviewUrlsOpt = {}) {
-  return new Promise(async (resolve, reject) => {
-    const { axios: _ax = axios, axiosConf, previewUrl } = opt || {};
-
-    const _axios = _ax;
-
-    let _list = urlList;
-    if (_list && !Array.isArray(_list)) {
-      _list = [_list];
-    }
-
-    return _axios
-      .post(previewUrl || "/api/v1/upload/preview", _list, { ...axiosConf })
-      .then((res) => {
-        if (res?.data?.code == 200) {
-          resolve(res?.data?.data);
-        } else {
-          reject(res);
-        }
-        return res;
-      })
-      .catch((err) => {
-        console.error("offline upload err", err);
-        reject(err);
-        return Promise.reject(err);
-      });
-  });
-};
-
-/**
- * 获取预览地址
- * @param url
- * @param opt
- * @returns
- */
-export const getPreviewUrl = function (url, opt: IGetPreviewUrlsOpt = {}) {
-  return new Promise(async (resolve, reject) => {
-    const { axios: _ax = axios, axiosConf, previewUrl } = opt || {};
-
-    const _axios = _ax;
-
-    return _axios
-      .post(previewUrl || "/api/v1/upload/preview", [url], { ...axiosConf })
-      .then((res) => {
-        if (res?.data?.code == 200) {
-          resolve(res?.data?.data?.[0]);
-        } else {
-          reject(res);
-        }
-        return res;
-      })
-      .catch((err) => {
-        console.error("offline upload err", err);
-        reject(err);
-        return Promise.reject(err);
-      });
-  });
-};
-
-/**
- * 私有部署版文件上传
- */
-export class OfflineUpload {
-  axios;
-  axiosConf;
-  serverUrl;
-  signatureParams;
-  constructor(props: IOfflineUploadProps = {}) {
-    this.axios = props.axios || axios;
-    this.axiosConf = props.axiosConf || {};
-    this.serverUrl = props.serverUrl || "/api/v1/upload/init";
-    this.signatureParams = props.signatureParams || {};
-  }
-
-  getSignature(serverUrl = this.serverUrl, opt) {
-    // path 前缀 oss-upload 文件目录
-    opt.params.path = mergeDirStr("web-upload/", opt.params.path ?? opt.params.dir);
-    return getSignature({
-      ...opt,
-      serverUrl,
-      axios: opt?.axios || this.axios,
-      axiosConf: { ...this.axiosConf, ...opt?.axiosConf },
-    });
-  }
-
-  upload(file, opt: IUploadOpt = {}) {
-    return new Promise(async (resolve, reject) => {
-      // filename 表示待上传的本地文件名称。
-      const filename = getFileNameByFileObj(file, opt);
-      try {
-        const fileInfo = await this.getSignature(opt.serverUrl || this.serverUrl, {
-          ...opt,
-          params: {
-            /** 最终保存的文件名称（不传默认文件名） */
-            filename,
-            /** 存储路径（不传默认基础路径） */
-            path: opt.params?.dir || this.signatureParams?.dir,
-            /** 文件存储平台（1、s3，2、本地存储，3、FTP，默认s3） */
-            platformCode: undefined,
-            ...this.signatureParams,
-            ...opt.params,
-          },
-        });
-        const { uploadUrl, ossParams: propOssParams } = opt || {};
-        const formData = new FormData();
-        formData.set("fileInfo", fileInfo);
-        formData.set("file", file);
-
-        if (propOssParams) {
-          for (const key in propOssParams) {
-            if (Object.hasOwnProperty.call(propOssParams, key)) {
-              formData.set(key, propOssParams[key]);
-            }
-          }
-        }
-
-        const _axios = opt?.axios || this.axios;
-
-        return _axios
-          .post(uploadUrl || "/api/v1/upload/execute", formData, { ...this.axiosConf, ...opt?.axiosConf })
-          .then((res) => {
-            if (res?.data?.code == 200) {
-              resolve(res?.data?.data);
-            } else {
-              reject(res);
-            }
-            return res;
-          })
-          .catch((err) => {
-            console.error("offline upload err", err);
-            reject(err);
-            return Promise.reject(err);
-          });
-      } catch (error) {
-        reject(error);
-        return Promise.reject(error);
-      }
-    });
-  }
-
-  /**
-   * 获取预览地址
-   * @param urlList
-   * @param opt
-   * @returns
-   */
-  getPreviewUrls(urlList, opt) {
-    return getPreviewUrls(urlList, {
-      ...opt,
-      axios: opt?.axios || this.axios,
-      axiosConf: { ...this.axiosConf, ...opt?.axiosConf },
-    });
-  }
-}
-
-/**
- * 批量处理预览地址
- * @param fileList
- * @param opt
- * @returns
- */
-export const handlePreviewUrls = async function (fileList, opt: IGetPreviewUrlsOpt) {
-  const res = await getPreviewUrls(
-    fileList?.map((it) => it.storeUrl || it.url),
-    {
-      ...opt,
-    },
-  );
-
-  fileList.forEach((it, i) => {
-    // TODO: storeUrl 来源于【本地 url 直接使用预览地址，解决 previewFile 无法正常使用 previewUrl 的问题】
-    if (!it.storeUrl) {
-      it.storeUrl = it.url;
-    }
-    // TODO: 本地 url 直接使用预览地址，解决 previewFile 无法正常使用 previewUrl 的问题
-    it.url = res[i].presignedUrl;
-
-    // 常规预览地址写法
-    it.previewUrl = res[i].presignedUrl;
-    if (it.uploadInfo) {
-      it.uploadInfo.previewUrl = it.previewUrl;
-    }
-  });
-  return fileList;
-};
-
-export default OfflineUpload;
+import dayjs from "dayjs";
+import { Axios, AxiosRequestConfig } from "axios";
+
+import { axios } from "@hzab/data-model";
+
+import { formatDirStr, mergeDirStr, getFileNameByFileObj } from "./uploadUtils";
+
+/**
+ * 获取上传相关配置入参
+ */
+export interface IGetSignatureOpt {
+  /**
+   * 配置接口地址
+   */
+  serverUrl?: string;
+  /**
+   * axios 实例
+   */
+  axios?: Axios;
+  /**
+   * axios 配置
+   */
+  axiosConf?: AxiosRequestConfig;
+  /**
+   * 请求入参
+   */
+  params?: {
+    path?: string;
+  };
+}
+
+export interface IOfflineUploadProps {
+  /**
+   * axios 实例
+   */
+  axios?: Axios;
+  /**
+   * axios 配置
+   */
+  axiosConf?: AxiosRequestConfig;
+  /**
+   * 配置接口地址
+   */
+  serverUrl?: string;
+  /**
+   * 获取配置接口请求入参
+   */
+  signatureParams?: {
+    path?: string;
+  };
+}
+
+/**
+ * 文件上传入参
+ */
+export interface IUploadOpt {
+  /**
+   * 配置接口地址
+   */
+  serverUrl?: string;
+  /**
+   * 是否开启 Hash 命名
+   */
+  useHashName?: boolean;
+  /**
+   * 文件上传接口地址
+   */
+  uploadUrl?: string;
+  /**
+   * 获取配置接口请求入参
+   */
+  params?: {
+    path?: string;
+    // 兼容 老数据
+    dir?: string;
+  };
+  /**
+   * 文件上传请求入参
+   */
+  ossParams?: {
+    path?: string;
+    // 兼容 老数据
+    dir?: string;
+  };
+  /**
+   * axios 实例
+   */
+  axios?: Axios;
+  /**
+   * axios 配置
+   */
+  axiosConf?: AxiosRequestConfig;
+}
+
+/**
+ * 获取上传配置
+ * @param opt
+ * @returns
+ */
+export function getSignature(opt: IGetSignatureOpt = {}) {
+  const { serverUrl = "/api/v1/upload/init" } = opt;
+  // 减 10 秒，避免发起请求时 刚好过期的情况
+  const { axios: _ax = axios, params = {}, axiosConf } = opt;
+  if (
+    window._$offlineSignatureRes &&
+    window._$offlineSignatureRes.data &&
+    serverUrl + JSON.stringify(params) === window._$offlineSignatureRes.serverUrlParams &&
+    dayjs().valueOf() - window._$offlineSignatureRes.__saveTime < window._$offlineSignatureRes.expireTimeMilles - 10000
+  ) {
+    return Promise.resolve(window._$offlineSignatureRes.data);
+  }
+  // 处理 path 格式，必须为非 / 开头， /  结尾。如： test/
+  params.path = formatDirStr(params.path);
+
+  return _ax
+    .post(
+      serverUrl,
+      {
+        ...params,
+      },
+      {
+        ...axiosConf,
+      },
+    )
+    .then((res) => {
+      if (res?.data?.code === 500) {
+        return Promise.reject(res.data);
+      }
+      if (res?.data?.code === 200) {
+        window._$offlineSignatureRes = {
+          data: res?.data?.data,
+        };
+        if (window._$offlineSignatureRes) {
+          window._$offlineSignatureRes.__saveTime = dayjs().valueOf();
+          window._$offlineSignatureRes.serverUrlParams = serverUrl + JSON.stringify(params);
+        }
+        return window._$offlineSignatureRes.data;
+      }
+    });
+}
+
+export interface IGetPreviewUrlsOpt {
+  previewUrl?: string;
+  params?: Object;
+  axios?: Axios;
+  axiosConf?: AxiosRequestConfig;
+}
+
+/**
+ * 获取预览地址-批量
+ * @param urlList
+ * @param opt
+ * @returns
+ */
+export const getPreviewUrls = function (urlList, opt: IGetPreviewUrlsOpt = {}) {
+  return new Promise(async (resolve, reject) => {
+    const { axios: _ax = axios, axiosConf, previewUrl } = opt || {};
+
+    const _axios = _ax;
+
+    let _list = urlList;
+    if (_list && !Array.isArray(_list)) {
+      _list = [_list];
+    }
+
+    return _axios
+      .post(previewUrl || "/api/v1/upload/preview", _list, { ...axiosConf })
+      .then((res) => {
+        if (res?.data?.code == 200) {
+          resolve(res?.data?.data);
+        } else {
+          reject(res);
+        }
+        return res;
+      })
+      .catch((err) => {
+        console.error("offline upload err", err);
+        reject(err);
+        return Promise.reject(err);
+      });
+  });
+};
+
+/**
+ * 获取预览地址
+ * @param url
+ * @param opt
+ * @returns
+ */
+export const getPreviewUrl = function (url, opt: IGetPreviewUrlsOpt = {}) {
+  return new Promise(async (resolve, reject) => {
+    const { axios: _ax = axios, axiosConf, previewUrl } = opt || {};
+
+    const _axios = _ax;
+
+    return _axios
+      .post(previewUrl || "/api/v1/upload/preview", [url], { ...axiosConf })
+      .then((res) => {
+        if (res?.data?.code == 200) {
+          resolve(res?.data?.data?.[0]);
+        } else {
+          reject(res);
+        }
+        return res;
+      })
+      .catch((err) => {
+        console.error("offline upload err", err);
+        reject(err);
+        return Promise.reject(err);
+      });
+  });
+};
+
+/**
+ * 私有部署版文件上传
+ */
+export class OfflineUpload {
+  axios;
+  axiosConf;
+  serverUrl;
+  signatureParams;
+  constructor(props: IOfflineUploadProps = {}) {
+    this.axios = props.axios || axios;
+    this.axiosConf = props.axiosConf || {};
+    this.serverUrl = props.serverUrl || "/api/v1/upload/init";
+    this.signatureParams = props.signatureParams || {};
+  }
+
+  getSignature(serverUrl = this.serverUrl, opt) {
+    // path 前缀 oss-upload 文件目录
+    const prePath = opt?.params?.hasPrePath !== false ? "web-upload/" : "";
+    opt.params.dir = mergeDirStr(prePath, opt.params.path ?? opt.params.dir);
+    return getSignature({
+      ...opt,
+      serverUrl,
+      axios: opt?.axios || this.axios,
+      axiosConf: { ...this.axiosConf, ...opt?.axiosConf },
+    });
+  }
+
+  upload(file, opt: IUploadOpt = {}) {
+    return new Promise(async (resolve, reject) => {
+      // filename 表示待上传的本地文件名称。
+      const filename = getFileNameByFileObj(file, opt);
+      try {
+        const fileInfo = await this.getSignature(opt.serverUrl || this.serverUrl, {
+          ...opt,
+          params: {
+            /** 最终保存的文件名称（不传默认文件名） */
+            filename,
+            /** 存储路径（不传默认基础路径） */
+            path: opt.params?.dir || this.signatureParams?.dir,
+            /** 文件存储平台（1、s3，2、本地存储，3、FTP，默认s3） */
+            platformCode: undefined,
+            ...this.signatureParams,
+            ...opt.params,
+          },
+        });
+        const { uploadUrl, ossParams: propOssParams } = opt || {};
+        const formData = new FormData();
+        formData.set("fileInfo", fileInfo);
+        formData.set("file", file);
+
+        if (propOssParams) {
+          for (const key in propOssParams) {
+            if (Object.hasOwnProperty.call(propOssParams, key)) {
+              formData.set(key, propOssParams[key]);
+            }
+          }
+        }
+
+        const _axios = opt?.axios || this.axios;
+
+        return _axios
+          .post(uploadUrl || "/api/v1/upload/execute", formData, { ...this.axiosConf, ...opt?.axiosConf })
+          .then((res) => {
+            if (res?.data?.code == 200) {
+              resolve(res?.data?.data);
+            } else {
+              reject(res);
+            }
+            return res;
+          })
+          .catch((err) => {
+            console.error("offline upload err", err);
+            reject(err);
+            return Promise.reject(err);
+          });
+      } catch (error) {
+        reject(error);
+        return Promise.reject(error);
+      }
+    });
+  }
+
+  /**
+   * 获取预览地址
+   * @param urlList
+   * @param opt
+   * @returns
+   */
+  getPreviewUrls(urlList, opt) {
+    return getPreviewUrls(urlList, {
+      ...opt,
+      axios: opt?.axios || this.axios,
+      axiosConf: { ...this.axiosConf, ...opt?.axiosConf },
+    });
+  }
+}
+
+/**
+ * 批量处理预览地址
+ * @param fileList
+ * @param opt
+ * @returns
+ */
+export const handlePreviewUrls = async function (fileList, opt: IGetPreviewUrlsOpt) {
+  const res = await getPreviewUrls(
+    fileList?.map((it) => it.storeUrl || it.url),
+    {
+      ...opt,
+    },
+  );
+
+  fileList.forEach((it, i) => {
+    // TODO: storeUrl 来源于【本地 url 直接使用预览地址，解决 previewFile 无法正常使用 previewUrl 的问题】
+    if (!it.storeUrl) {
+      it.storeUrl = it.url;
+    }
+    // TODO: 本地 url 直接使用预览地址，解决 previewFile 无法正常使用 previewUrl 的问题
+    it.url = res[i].presignedUrl;
+
+    // 常规预览地址写法
+    it.previewUrl = res[i].presignedUrl;
+    if (it.uploadInfo) {
+      it.uploadInfo.previewUrl = it.previewUrl;
+    }
+  });
+  return fileList;
+};
+
+export default OfflineUpload;