@hzab/utils 0.0.1

package/src/options.ts

@@ -0,0 +1,226 @@
+import { cloneDeep } from "lodash";
+
+import { checkEmpty, handleEmptyVal, IHandleEmptyValOpt } from "./empty-val";
+
+export interface IFieldNames {
+  value?: string;
+  label?: string;
+  children?: string;
+}
+
+export interface IFindOptionOpt extends IHandleEmptyValOpt {
+  fieldNames?: IFieldNames;
+  // 是否返回完整的路径数组
+  isPathList?: boolean;
+  pathList?: Array<any>;
+  labelList?: Array<string>;
+  parent?: any;
+}
+
+export interface IGetArrayLabels extends IFindOptionOpt {
+  split?: string;
+}
+
+export interface IGetValLabelOpt extends IHandleEmptyValOpt {
+  showEmpty?: boolean;
+}
+
+export type formatOptionsOptT = {
+  fieldNames?: IFieldNames;
+  sourceFieldNames?: IFieldNames;
+  /**
+   * 是否清除其他参数
+   */
+  isClear?: boolean;
+};
+
+export const DEF_FIELD_NAMES = {
+  value: "value",
+  label: "label",
+  children: "children",
+};
+
+/**
+ * 获取无限级数据的选中项
+ * @param val
+ * @param options
+ * @param opt
+ * @returns
+ */
+export const findOptionByVal = function (
+  val,
+  options,
+  opt: IFindOptionOpt = {
+    // 是否返回完整的路径数组
+    isPathList: false,
+    pathList: [],
+    labelList: [],
+    parent: undefined,
+    fieldNames: {
+      label: "label",
+      value: "value",
+      children: "children",
+    },
+  },
+) {
+  if (!options) {
+    console.warn("getDeepData 请传入 options");
+    return;
+  }
+  const { fieldNames, isPathList, pathList = [], labelList = [] } = opt || {};
+  const { label = "label", value = "value", children = "children" } = fieldNames || {};
+  const res = options.find((it) => it[value] === val);
+  if (res) {
+    if (isPathList) {
+      pathList.unshift(res);
+      labelList.unshift(res[label]);
+      return {
+        last: res,
+        pathList,
+        labelList,
+      };
+    }
+    return res;
+  }
+  const len = options.length;
+  for (let i = 0; i < len; i++) {
+    const item = options[i];
+    const childList = item[children];
+    if (Array.isArray(childList) && childList.length > 0) {
+      const res = findOptionByVal(val, childList, {
+        ...opt,
+        parent: item,
+        pathList,
+        labelList,
+      });
+      if (res) {
+        if (isPathList) {
+          pathList.unshift(item);
+          labelList.unshift(item[label]);
+          return {
+            last: res.last,
+            labelList,
+            pathList,
+          };
+        }
+        return res;
+      }
+    }
+  }
+};
+
+/**
+ * 获取 options 中 val 对应的 label
+ * @param {*} val
+ * @param {Array<Object>} options
+ * @param {Object} opt
+ * @returns
+ */
+export const getOptionLabel = function (val, options = [], opt: IFindOptionOpt = {}) {
+  const { fieldNames = DEF_FIELD_NAMES } = opt || {};
+  return findOptionByVal(val, options, opt)?.[fieldNames?.label || DEF_FIELD_NAMES.label];
+};
+
+/**
+ * 获取 options 中的指定项 的 label
+ * @param {*} val
+ * @param {*} options
+ * @param {*} opt
+ * @returns
+ */
+export function getValLabel(val, options = [], opt: IGetValLabelOpt = {}) {
+  const { showEmpty } = opt;
+  if (showEmpty && checkEmpty(val, opt)) {
+    return handleEmptyVal(val, opt);
+  }
+  return getOptionLabel(val, options, opt);
+}
+
+/**
+ * 获取 options 中的指定项 的 label 数组
+ * @param {*} values
+ * @param {*} options
+ * @param {*} opt
+ * @returns
+ */
+export function getArrayLabels(values, options, opt: IGetArrayLabels = {}) {
+  if (checkEmpty(values, opt)) {
+    return handleEmptyVal(values, opt);
+  }
+  const { split = "、" } = opt || {};
+  let _values = values;
+  if (!Array.isArray(_values)) {
+    _values = [_values];
+  }
+  return _values
+    ?.map((val) => getOptionLabel(val, options, opt) ?? val)
+    ?.filter((it) => (it ?? it) || false)
+    ?.join(split);
+}
+
+/**
+ * 格式化 options 数组
+ */
+export const formatOptions = function (options, opt: formatOptionsOptT = {}) {
+  if (!Array.isArray(options)) {
+    console.warn("formatOptions Error: options not Array");
+    return options;
+  }
+
+  const {
+    fieldNames = DEF_FIELD_NAMES,
+    sourceFieldNames = DEF_FIELD_NAMES,
+    // 是否清除其他参数
+    isClear,
+  } = opt || {};
+
+  const { label, value, children } = fieldNames;
+  const { label: sLabel, value: sValue, children: sChildren } = sourceFieldNames;
+
+  const _options = cloneDeep(options);
+  const resOptions = [];
+  _options.forEach((it) => {
+    const _it = isClear ? {} : { ...it };
+    _it[value] = it[sValue];
+    _it[label] = it[sLabel];
+    resOptions.push(_it);
+    const childList = it[sChildren];
+    if (childList) {
+      _it[children] = formatOptions(childList, opt);
+    }
+  });
+  return resOptions;
+};
+
+/**
+ * 根据 val 获取对应的 options 项数据，并进行数据归一化处理
+ * value, label, children
+ * @param {string|number|boolean} val
+ * @param {Object} field
+ */
+export const getOptItByVal = function (val, options, opt) {
+  const { fieldNames } = opt || {};
+  const { value = "value", label = "label", children = "children" } = fieldNames || {};
+  for (let i = 0; i < options.length; i++) {
+    const it = options[i];
+    if (it?.[value] === val) {
+      return {
+        ...it,
+        value: it?.[value],
+        label: it?.[label],
+        children: it?.[children],
+      };
+    }
+    // 递归处理
+    const _children = it?.[children];
+    if (Array.isArray(_children) && _children.length > 0) {
+      const child = getOptItByVal(val, _children, opt);
+      return {
+        ...child,
+        value: child?.[value],
+        label: child?.[label],
+        children: child?.[children],
+      };
+    }
+  }
+};

package/src/string.ts

@@ -0,0 +1,19 @@
+/**
+ * 是否是 base64 字符串
+ * @param {*} str
+ * @returns
+ */
+export const isBase64Str = function (str) {
+  return /^data:\w+\/\w+;base64/i.test(str);
+};
+
+/**
+ * 字符串中划线转为小驼峰
+ * @param s
+ * @returns
+ */
+export const convertToCamelCase = function (s) {
+  return s.replace(/-(\w)/g, function (all, letter) {
+    return letter.toUpperCase();
+  });
+};

package/src/upload/OfflineUpload.ts

@@ -0,0 +1,338 @@
+import { axios } from "@hzab/data-model";
+
+import { formatDirStr, mergeDirStr, getFileNameByFileObj } from "./uploadUtils";
+
+/**
+ * 获取上传相关配置入参
+ */
+export interface IGetSignatureOpt {
+  /**
+   * 配置接口地址
+   */
+  serverUrl?: string;
+  /**
+   * axios 实例
+   */
+  axios?: Object;
+  /**
+   * axios 配置
+   */
+  axiosConf?: Object;
+  /**
+   * 请求入参
+   */
+  params?: {
+    path?: string;
+  };
+}
+
+export interface IOfflineUploadProps {
+  /**
+   * axios 实例
+   */
+  axios?: Object;
+  /**
+   * axios 配置
+   */
+  axiosConf?: Object;
+  /**
+   * 配置接口地址
+   */
+  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?: Object;
+  /**
+   * axios 配置
+   */
+  axiosConf?: Object;
+}
+
+/**
+ * 获取上传配置
+ * @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 &&
+    Date.now() - 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 = Date.now();
+          window._$offlineSignatureRes.serverUrlParams = serverUrl + JSON.stringify(params);
+        }
+        return window._$offlineSignatureRes.data;
+      }
+    });
+}
+
+export interface IGetPreviewUrlsOpt {
+  previewUrl?: string;
+  params?: Object;
+  axios?: Object;
+  axiosConf?: Object;
+}
+
+/**
+ * 获取预览地址-批量
+ * @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;