@hzab/utils 1.1.2 → 1.1.3

package/src/upload/fileDataNormalization.ts

@@ -1,281 +1,281 @@
-/**
- * 文件数据格式归一化
- */
-import dayjs from "dayjs";
-
-import { nanoidNumALetters } from "../nanoid";
-import { objStrToObj } from "../string";
-import { isBase64Str, getFileTypeFromBase64 } from "../base64Str";
-import { getFileURL } from "../file/file";
-import { getFileType } from "../file/fileType";
-import { getUFileName, getFileName, getFullFileName, getFileExt } from "../file/fileName";
-import { getFileNameObj, mergePreviewConfig } from "./uploadUtils";
-
-/**
- * 文件数据格式
- */
-export interface IFile {
-  /** 唯一 id */
-  uid?: string;
-  /** 唯一 id */
-  id: string;
-  /** 文件地址 */
-  url: string;
-  /** 存储的文件地址 */
-  storeUrl: string;
-  /** 存储的文件名称 */
-  name?: string;
-  /** 存储的文件名称 */
-  filename?: string;
-  /** 上传的文件名称 */
-  originalFilename: string;
-  /** 基础路径 */
-  basePath?: string;
-  /** 存储路径 */
-  path?: string;
-  /** 文件后缀 */
-  ext?: string;
-  /** 文件类型 */
-  contentType: string;
-  /** 上传平台 */
-  platform: string;
-  /** 文件预览地址 */
-  previewUrl?: string;
-  /** 文件缩略图地址 */
-  thumbnailUrl?: string;
-  /** 文件类型 */
-  type: string;
-  /** 文件大小 */
-  size: number;
-  /** 原始 file 文件 */
-  originFileObj?: File;
-  /** 文件上传时间 */
-  createTime?: string;
-  /** 最后更新时间戳 */
-  lastModified?: number;
-}
-
-/**
- * 数据处理配置项
- */
-export interface INormalizationOpt {
-  /** 列表数据模式：数组 | 字符串 */
-  listMode: "array" | "jsonStr" | "splitStr";
-  /** 字符串列表数据模式下的分隔符 */
-  split: string;
-  /** 子项数据模式： 格式化对象 | file 文件格式 | url 地址 | JSON 序列化字符串 */
-  itemMode: "object" | "file" | "url" | "jsonStr";
-  /** 预览配置参数 */
-  previewConfig?: Object;
-  /** 设置预览 URL 的回调 */
-  getPreviewUrl?: (file, opt) => string;
-  /** 缩略图配置参数 */
-  thumbnailUrlConf?: Object;
-  /** 设置缩略图 URL 的回调 */
-  getThumbnailUrl?: (file, opt) => string;
-}
-
-/** 内部文件格式 */
-const fileTpl: IFile = {
-  uid: "",
-  id: "",
-  url: "",
-  storeUrl: "",
-  name: "",
-  filename: "",
-  originalFilename: "",
-  basePath: "",
-  path: "",
-  ext: "",
-  type: "",
-  contentType: "",
-  previewUrl: undefined,
-  size: undefined,
-  platform: undefined,
-  lastModified: undefined,
-  createTime: undefined,
-  originFileObj: undefined,
-};
-
-/**
- * 文件数据格式归一化
- */
-export const normalizationFileObj = (data: IFile, opt: INormalizationOpt) => {
-  if (!data) {
-    console.warn("Upload handleInputData 请传入正确的数据");
-    return data;
-  }
-  let file = {
-    ...fileTpl,
-  };
-  // 对象字符串 转为 对象
-  const _data = objStrToObj(data);
-  if (isBase64Str(_data)) {
-    // base64 格式
-    file.id = nanoidNumALetters();
-    file.uid = file.id;
-    file.url = _data;
-    file.storeUrl = _data;
-    file.name = file.id;
-    file.filename = file.name;
-    file.originalFilename = file.name;
-    // 根据 base64 数据获取文件类型
-    const typeObj = getFileTypeFromBase64(_data);
-    file.type = typeObj.mimeType;
-    file.ext = typeObj.type;
-  } else if (typeof _data === "string") {
-    // url 格式
-    const obj = getFileNameObj(_data);
-    file.id = obj?.id;
-    file.uid = file.id;
-    file.url = _data;
-    file.storeUrl = _data;
-    file.name = getFullFileName(file.url);
-    file.filename = file.name;
-    file.originalFilename = getFullFileName(file.url);
-    file.type = getFileType(file.url);
-    file.ext = getFileExt(file.url);
-  } else if (typeof _data === "object") {
-    const sourceData = _data.originFileObj || _data;
-    file.id = _data.id || _data.uid;
-    file.url = sourceData.url || sourceData.ossUrl;
-    file.storeUrl = file.url;
-    file.originalFilename = _data.originalFilename || getFullFileName(file.url) || _data.name;
-    file.name = _data.filename || _data.name || getFullFileName(file.url);
-    file.filename = file.name;
-    file.originFileObj = data instanceof File ? data : undefined;
-    file.lastModified = _data.lastModified;
-    file.basePath = _data.basePath;
-    file.path = _data.path;
-    file.ext = getFileExt(file.url);
-    file.type = _data.contentType || _data.type;
-    file.contentType = file.type;
-    file.size = _data.size;
-    file.platform = _data.platform;
-    file.createTime = _data.createTime;
-  }
-
-  if (!file.id) {
-    file.id =
-      file.uid ||
-      `${
-        getFileName(file.url || file.name || file.filename) || "rc-upload"
-      }-${dayjs().valueOf()}-${nanoidNumALetters()}`;
-  }
-  if (!file.name) {
-    file.name = file.id;
-  }
-  if (!file.filename) {
-    file.filename = file.name;
-  }
-  if (!file.storeUrl) {
-    file.storeUrl = file.url;
-  }
-
-  // 预览地址
-  if (!file.previewUrl) {
-    const { getPreviewUrl, previewConfig } = opt || {};
-    file.previewUrl = getPreviewUrl ? getPreviewUrl(file, opt) : mergePreviewConfig(file, previewConfig);
-  }
-  // 缩略图地址
-  if (!file.thumbnailUrl) {
-    const { getThumbnailUrl, thumbnailUrlConf } = opt || {};
-    file.thumbnailUrl = getThumbnailUrl ? getThumbnailUrl(file, opt) : mergePreviewConfig(file, thumbnailUrlConf);
-  }
-
-  return file;
-};
-
-/**
- * 解析传入的文件列表数据
- */
-export const parseFileList = (fileList, opt: INormalizationOpt) => {
-  if (!fileList) {
-    return [];
-  }
-
-  let _fileList = fileList;
-  const { listMode, split } = opt || {};
-
-  // splitStr jsonStr 模式下处理字符串
-  const isStr = typeof _fileList === "string";
-  if (isStr && listMode === "splitStr") {
-    // @ts-ignore
-    _fileList = _fileList?.split(split ?? ", ");
-  }
-
-  if (isStr && listMode === "jsonStr") {
-    _fileList = objStrToObj(_fileList);
-  }
-
-  const isArr = Array.isArray(_fileList);
-  // 统一成数组格式
-  if (_fileList !== null && _fileList !== undefined && !isArr) {
-    _fileList = [_fileList];
-  }
-
-  if (isArr) {
-    const arrRes = [];
-    _fileList.forEach((it) => {
-      const itRes = normalizationFileObj(it, opt);
-      itRes && arrRes.push(itRes);
-    });
-    return arrRes;
-  }
-  return _fileList;
-};
-
-/**
- * 出参子项归一化
- * 根据配置，将 对象 处理成所需格式
- */
-export const formatFile = function (file, opt: INormalizationOpt) {
-  const { itemMode = "object" } = opt || {};
-  if (itemMode === "file") {
-    return file?.originFileObj || file;
-  }
-  if (itemMode === "object") {
-    return normalizationFileObj(file, opt);
-  }
-  if (itemMode === "jsonStr" && typeof file !== "string") {
-    const { originFileObj, ...jFile } = normalizationFileObj(file, opt);
-    return JSON.stringify({ ...jFile });
-  }
-  if (itemMode === "url") {
-    return typeof file === "string" ? file : file.originFileObj?.url || file?.url;
-  }
-  return file;
-};
-
-/**
- * 出参 fileList 归一化
- * 根据配置，将 对象 处理成所需格式
- */
-export const formatFileList = function (fileList, opt: INormalizationOpt) {
-  if (!fileList) {
-    return undefined;
-  }
-
-  const { listMode, split } = opt || {};
-
-  let _fileList = fileList;
-  if (_fileList && !Array.isArray(_fileList)) {
-    _fileList = [fileList];
-  }
-
-  // 数组
-  if (listMode === "array") {
-    return _fileList?.map((it) => formatFile(it, opt));
-  }
-  // 序列化后的字符串
-  if (listMode === "jsonStr") {
-    return JSON.stringify(_fileList?.map((it) => formatFile(it, opt)));
-  }
-  // join 后的字符串
-  if (listMode === "splitStr") {
-    return _fileList
-      ?.map((it) => formatFile(it, opt))
-      .filter((it) => it)
-      .join(split ?? ", ");
-  }
-};
+/**
+ * 文件数据格式归一化
+ */
+import dayjs from "dayjs";
+
+import { nanoidNumALetters } from "../nanoid";
+import { objStrToObj } from "../string";
+import { isBase64Str, getFileTypeFromBase64 } from "../base64Str";
+import { getFileURL } from "../file/file";
+import { getFileType } from "../file/fileType";
+import { getUFileName, getFileName, getFullFileName, getFileExt } from "../file/fileName";
+import { getFileNameObj, mergePreviewConfig } from "./uploadUtils";
+
+/**
+ * 文件数据格式
+ */
+export interface IFile {
+  /** 唯一 id */
+  uid?: string;
+  /** 唯一 id */
+  id: string;
+  /** 文件地址 */
+  url: string;
+  /** 存储的文件地址 */
+  storeUrl: string;
+  /** 存储的文件名称 */
+  name?: string;
+  /** 存储的文件名称 */
+  filename?: string;
+  /** 上传的文件名称 */
+  originalFilename: string;
+  /** 基础路径 */
+  basePath?: string;
+  /** 存储路径 */
+  path?: string;
+  /** 文件后缀 */
+  ext?: string;
+  /** 文件类型 */
+  contentType: string;
+  /** 上传平台 */
+  platform: string;
+  /** 文件预览地址 */
+  previewUrl?: string;
+  /** 文件缩略图地址 */
+  thumbnailUrl?: string;
+  /** 文件类型 */
+  type: string;
+  /** 文件大小 */
+  size: number;
+  /** 原始 file 文件 */
+  originFileObj?: File;
+  /** 文件上传时间 */
+  createTime?: string;
+  /** 最后更新时间戳 */
+  lastModified?: number;
+}
+
+/**
+ * 数据处理配置项
+ */
+export interface INormalizationOpt {
+  /** 列表数据模式：数组 | 字符串 */
+  listMode: "array" | "jsonStr" | "splitStr";
+  /** 字符串列表数据模式下的分隔符 */
+  split: string;
+  /** 子项数据模式： 格式化对象 | file 文件格式 | url 地址 | JSON 序列化字符串 */
+  itemMode: "object" | "file" | "url" | "jsonStr";
+  /** 预览配置参数 */
+  previewConfig?: Object;
+  /** 设置预览 URL 的回调 */
+  getPreviewUrl?: (file, opt) => string;
+  /** 缩略图配置参数 */
+  thumbnailUrlConf?: Object;
+  /** 设置缩略图 URL 的回调 */
+  getThumbnailUrl?: (file, opt) => string;
+}
+
+/** 内部文件格式 */
+const fileTpl: IFile = {
+  uid: "",
+  id: "",
+  url: "",
+  storeUrl: "",
+  name: "",
+  filename: "",
+  originalFilename: "",
+  basePath: "",
+  path: "",
+  ext: "",
+  type: "",
+  contentType: "",
+  previewUrl: undefined,
+  size: undefined,
+  platform: undefined,
+  lastModified: undefined,
+  createTime: undefined,
+  originFileObj: undefined,
+};
+
+/**
+ * 文件数据格式归一化
+ */
+export const normalizationFileObj = (data: IFile, opt: INormalizationOpt) => {
+  if (!data) {
+    console.warn("Upload handleInputData 请传入正确的数据");
+    return data;
+  }
+  let file = {
+    ...fileTpl,
+  };
+  // 对象字符串 转为 对象
+  const _data = objStrToObj(data);
+  if (isBase64Str(_data)) {
+    // base64 格式
+    file.id = nanoidNumALetters();
+    file.uid = file.id;
+    file.url = _data;
+    file.storeUrl = _data;
+    file.name = file.id;
+    file.filename = file.name;
+    file.originalFilename = file.name;
+    // 根据 base64 数据获取文件类型
+    const typeObj = getFileTypeFromBase64(_data);
+    file.type = typeObj.mimeType;
+    file.ext = typeObj.type;
+  } else if (typeof _data === "string") {
+    // url 格式
+    const obj = getFileNameObj(_data);
+    file.id = obj?.id;
+    file.uid = file.id;
+    file.url = _data;
+    file.storeUrl = _data;
+    file.name = getFullFileName(file.url);
+    file.filename = file.name;
+    file.originalFilename = getFullFileName(file.url);
+    file.type = getFileType(file.url);
+    file.ext = getFileExt(file.url);
+  } else if (typeof _data === "object") {
+    const sourceData = _data.originFileObj || _data;
+    file.id = _data.id || _data.uid;
+    file.url = sourceData.url || sourceData.ossUrl;
+    file.storeUrl = file.url;
+    file.originalFilename = _data.originalFilename || getFullFileName(file.url) || _data.name;
+    file.name = _data.filename || _data.name || getFullFileName(file.url);
+    file.filename = file.name;
+    file.originFileObj = data instanceof File ? data : undefined;
+    file.lastModified = _data.lastModified;
+    file.basePath = _data.basePath;
+    file.path = _data.path;
+    file.ext = getFileExt(file.url);
+    file.type = _data.contentType || _data.type;
+    file.contentType = file.type;
+    file.size = _data.size;
+    file.platform = _data.platform;
+    file.createTime = _data.createTime;
+  }
+
+  if (!file.id) {
+    file.id =
+      file.uid ||
+      `${
+        getFileName(file.url || file.name || file.filename) || "rc-upload"
+      }-${dayjs().valueOf()}-${nanoidNumALetters()}`;
+  }
+  if (!file.name) {
+    file.name = file.id;
+  }
+  if (!file.filename) {
+    file.filename = file.name;
+  }
+  if (!file.storeUrl) {
+    file.storeUrl = file.url;
+  }
+
+  // 预览地址
+  if (!file.previewUrl) {
+    const { getPreviewUrl, previewConfig } = opt || {};
+    file.previewUrl = getPreviewUrl ? getPreviewUrl(file, opt) : mergePreviewConfig(file, previewConfig);
+  }
+  // 缩略图地址
+  if (!file.thumbnailUrl) {
+    const { getThumbnailUrl, thumbnailUrlConf } = opt || {};
+    file.thumbnailUrl = getThumbnailUrl ? getThumbnailUrl(file, opt) : mergePreviewConfig(file, thumbnailUrlConf);
+  }
+
+  return file;
+};
+
+/**
+ * 解析传入的文件列表数据
+ */
+export const parseFileList = (fileList, opt: INormalizationOpt) => {
+  if (!fileList) {
+    return [];
+  }
+
+  let _fileList = fileList;
+  const { listMode, split } = opt || {};
+
+  // splitStr jsonStr 模式下处理字符串
+  const isStr = typeof _fileList === "string";
+  if (isStr && listMode === "splitStr") {
+    // @ts-ignore
+    _fileList = _fileList?.split(split ?? ", ");
+  }
+
+  if (isStr && listMode === "jsonStr") {
+    _fileList = objStrToObj(_fileList);
+  }
+
+  const isArr = Array.isArray(_fileList);
+  // 统一成数组格式
+  if (_fileList !== null && _fileList !== undefined && !isArr) {
+    _fileList = [_fileList];
+  }
+
+  if (isArr) {
+    const arrRes = [];
+    _fileList.forEach((it) => {
+      const itRes = normalizationFileObj(it, opt);
+      itRes && arrRes.push(itRes);
+    });
+    return arrRes;
+  }
+  return _fileList;
+};
+
+/**
+ * 出参子项归一化
+ * 根据配置，将 对象 处理成所需格式
+ */
+export const formatFile = function (file, opt: INormalizationOpt) {
+  const { itemMode = "object" } = opt || {};
+  if (itemMode === "file") {
+    return file?.originFileObj || file;
+  }
+  if (itemMode === "object") {
+    return normalizationFileObj(file, opt);
+  }
+  if (itemMode === "jsonStr" && typeof file !== "string") {
+    const { originFileObj, ...jFile } = normalizationFileObj(file, opt);
+    return JSON.stringify({ ...jFile });
+  }
+  if (itemMode === "url") {
+    return typeof file === "string" ? file : file.originFileObj?.url || file?.url;
+  }
+  return file;
+};
+
+/**
+ * 出参 fileList 归一化
+ * 根据配置，将 对象 处理成所需格式
+ */
+export const formatFileList = function (fileList, opt: INormalizationOpt) {
+  if (!fileList) {
+    return undefined;
+  }
+
+  const { listMode, split } = opt || {};
+
+  let _fileList = fileList;
+  if (_fileList && !Array.isArray(_fileList)) {
+    _fileList = [fileList];
+  }
+
+  // 数组
+  if (listMode === "array") {
+    return _fileList?.map((it) => formatFile(it, opt));
+  }
+  // 序列化后的字符串
+  if (listMode === "jsonStr") {
+    return JSON.stringify(_fileList?.map((it) => formatFile(it, opt)));
+  }
+  // join 后的字符串
+  if (listMode === "splitStr") {
+    return _fileList
+      ?.map((it) => formatFile(it, opt))
+      .filter((it) => it)
+      .join(split ?? ", ");
+  }
+};

package/src/upload/ossUpload.ts

@@ -1,23 +1,23 @@
-import { mergeDirStr, getFileNameByFileObj } from "./uploadUtils";
-import OssUploadUtil, { axios, IUploadOpt } from "./OssUploadUtil";
-
-/**
- * oss 上传工具类
- */
-class OssUpload extends OssUploadUtil {
-  getSignature(serverUrl = this.serverUrl, opt) {
-    // dir 前缀 oss-upload 文件目录
-    const prePath = opt?.params?.hasPrePath !== false ? "web-upload/" : "";
-    opt.params.dir = mergeDirStr(prePath, opt.params.dir);
-    return this._getSignature(serverUrl, opt);
-  }
-
-  upload(file, opt: IUploadOpt = {}): Promise<{ fileUrl: string }> {
-    const fileName = getFileNameByFileObj(file, opt);
-    return this._upload(file, { ...opt, fileName });
-  }
-}
-
-export { axios };
-
-export default OssUpload;
+import { mergeDirStr, getFileNameByFileObj } from "./uploadUtils";
+import OssUploadUtil, { axios, IUploadOpt } from "./OssUploadUtil";
+
+/**
+ * oss 上传工具类
+ */
+class OssUpload extends OssUploadUtil {
+  getSignature(serverUrl = this.serverUrl, opt) {
+    // dir 前缀 oss-upload 文件目录
+    const prePath = opt?.params?.hasPrePath !== false ? "web-upload/" : "";
+    opt.params.dir = mergeDirStr(prePath, opt.params.dir);
+    return this._getSignature(serverUrl, opt);
+  }
+
+  upload(file, opt: IUploadOpt = {}): Promise<{ fileUrl: string }> {
+    const fileName = getFileNameByFileObj(file, opt);
+    return this._upload(file, { ...opt, fileName });
+  }
+}
+
+export { axios };
+
+export default OssUpload;