@haluo/util 2.0.22 → 2.0.24

package/dist/modules/upload/aliOss.d.ts

@@ -1,23 +1,19 @@
 /**
- * @file 阿里云OSS上传统一工具类
+ * @file 阿里云OSS上传统一工具类 v4
  * @description 整合所有项目的aliOss业务逻辑，通过传参形式支持不同业务场景
  * @Author: wanghui
  * @createBy: @2025.11.17
  *
- * 文档：https://help.aliyun.com/document_detail/64041.html
- *
  * 使用示例：
  * ```typescript
  * import { createAliOssUploader } from '@haluo/util'
  *
  * // 创建上传实例，传入业务相关的API函数
  * const ossUploader = createAliOssUploader({
- *   getAliyunSts: (params) => api.getAliyunSts(params),
+ *   getSts: (params) => api.getSts(params),
  *   darkWaterUploadImage: (params) => api.darkWaterUploadImage(params),
  *   multiTransferImage: (params) => api.multiTransferImage(params),
- *   aliyunPersist: (params) => api.aliyunPersist(params),
  *   generatePrePresignedUrl: (params) => api.generatePrePresignedUrl(params),
- *   uploadConf: (params) => api.uploadConf(params),
  *   dateFormat: util.date.format, // 或 util.filter.format
  *   messageWarning: (msg) => window.$message.warning(msg)
  * })
@@ -25,9 +21,9 @@
  * // 图片上传
  * ossUploader.ossUploadImage({
  *   file: file,
+ *   businessType: 1500, // 业务类型 BusinessType
  *   imageType: 'official', // nowater、official、panoram、forum、avatar、square、carport
  *   quality: 0.7, // 压缩质量
- *   businessType: 1500, // 业务类型：0(无水印)、1(头像)、4(GIF)、6(视频)、8(UnProtect)、1000(文章)、1199(私有)、1299(加密)、1500(默认)
  *   batchTransfer: false, // 是否批量转换水印
  *   notCompress: false, // 是否不压缩
  *   idCard: false, // 是否身份证上传
@@ -39,10 +35,10 @@
  * // 文件上传
  * ossUploader.ossUploadFile({
  *   file: file,
+ *   businessType: 1500, // 业务类型 BusinessType
  *   isVideo: false, // 是否视频
  *   isUnProtect: false, // 是否UnProtect
  *   isDocument: false, // 是否文档
- *   businessType: 1500,
  *   onProgress: (e) => console.log(e.percent),
  *   onSuccess: (val) => console.log(val),
  *   onError: (err) => console.error(err)
@@ -51,21 +47,70 @@
  */
 /**
  * 业务类型枚举
- * 不同的businessType对应不同的OSS bucket和水印策略
  */
 export declare enum BusinessType {
-    NO_WATER = 0,
-    AVATAR = 1,
-    GIF = 4,
-    VIDEO = 6,
-    UNPROTECT = 8,
-    ARTICLE = 1000,
-    PRIVATE = 1199,
-    ENCRYPTED = 1299,
-    DEFAULT = 1500
+    /** 客户端上传图片(跟用户相关) */
+    /** 隐私图片 */
+    CREDIT = 130541736,
+    /** 内容 */
+    CONTENT = 101300784,
+    /** 头像 */
+    AVATAR = 134539448,
+    /** 二手车 */
+    USED_CAR = 171978237,
+    /** 商城 */
+    MALL = 115259415,
+    /** 魔友圈 */
+    HOOP = 155669648,
+    /** 用户 */
+    USER = 170244368,
+    /** 骑行 */
+    CYCLING = 165103952,
+    /** 玩车 */
+    MOTORCYCLE = 151637735,
+    /** 租车 */
+    RENTALCAR = 149095014,
+    /** 经销商 */
+    SHOP = 172655993,
+    /** 财务 */
+    FINANCE = 188717541,
+    /** 反馈 */
+    FEEDBACK = 182411383,
+    /** 驾校 */
+    DRIVING_SCHOOL = 172137757,
+    /** 评论图片 */
+    REPLY = 195929698,
+    /** 厂家 */
+    FACTORY = 118733601,
+    /** 骑行数据 */
+    CYCLING_DATA = 148681294,
+    /** 动图 */
+    GIF = 191290831,
+    /** 其他（原则上不可以使用） */
+    OTHER = 100694193,
+    /** 运营文件(跟用户无关) */
+    /** apk */
+    APK = 154033062,
+    /** 证书 */
+    CERT = 142668067,
+    /** oss数据文件（xlxs等） */
+    OSSDATA = 105038102,
+    /** 数据（题库等） */
+    DB = 180241065,
+    /** PDF */
+    PDF = 198157532,
+    /** 视频 */
+    VIDEOOPS = 172023381,
+    /** 运营图片(跟用户无关) */
+    /** 商城运营图片 */
+    MALLOPS = 137563987,
+    /** 运营图片 */
+    OSSOPS = 157532694,
+    /** 车库运营图片 */
+    CARPORT = 137563987
 }
 /**
- * 图片类型后缀枚举
+ * bucket 图片类型后缀枚举
  */
 export declare const SuffixEnum: {
     readonly nowater: "!nowater";
@@ -78,29 +123,15 @@ export declare const SuffixEnum: {
 };
 /** 图片类型 */
 export type ImageType = keyof typeof SuffixEnum;
-/**
- * OSS客户端配置接口
- */
-export interface OSSClientParams {
-    region?: string;
-    accessKeyId?: string;
-    accessKeySecret?: string;
-    stsToken?: string;
-    bucket?: string;
-    realmName?: string;
-    suffix?: string;
-    style?: string;
-    [key: string]: any;
-}
 /**
  * 上传结果接口
  */
 export interface UploadResult {
-    imgUrl?: string;
-    imgOrgUrl?: string;
+    imgUrl: string;
+    imgOrgUrl: string;
+    fileName: string;
+    name: string;
     url?: string;
-    fileName?: string;
-    name?: string;
     bucket?: string;
     [key: string]: any;
 }
@@ -109,13 +140,12 @@ export interface UploadResult {
  */
 export interface UploadOption {
     file: File;
+    businessType: BusinessType | number;
     imageType?: ImageType | string;
     quality?: number;
-    businessType?: BusinessType | number;
     batchTransfer?: boolean;
     notCompress?: boolean;
     idCard?: boolean;
-    imggeCarType?: any;
     isVideo?: boolean;
     isUnProtect?: boolean;
     isDocument?: boolean;
@@ -139,11 +169,13 @@ interface ApiResponse<T = any> {
  * 业务相关的API通过此接口传入，实现业务逻辑解耦
  */
 export interface AliOssApiConfig {
-    /** 获取阿里云STS临时凭证 - 必需 */
-    getAliyunSts: (params: {
-        businessType: number;
-        imggeCarType?: any;
-    }) => Promise<ApiResponse<OSSClientParams>>;
+    /** 获取STS，POST V4签名独有的表单元素- 必需 */
+    /** businessType: 业务编码(必传), docType: 文件格式如png(必传)，size: _1024_567(可选) */
+    getSts: (params: {
+        businessType: BusinessType;
+        docType: string;
+        size?: string;
+    }) => any;
     /** 暗水印上传接口 - 可选，用于carport类型 */
     darkWaterUploadImage?: (params: {
         file: File;
@@ -152,103 +184,64 @@ export interface AliOssApiConfig {
     multiTransferImage?: (params: {
         file: File;
     }) => Promise<ApiResponse<string>>;
-    /** 阿里云持久化接口 - 可选，用于avatar类型 */
-    aliyunPersist?: (params: {
-        object: string;
-        businessType: number;
-    }) => Promise<ApiResponse<string>>;
     /** 生成预签名URL接口 - 可选，用于idCard */
     generatePrePresignedUrl?: (params: {
         objectId: string;
         expireMils: number;
     }) => Promise<ApiResponse<string>>;
-    /** 上传配置接口 - 可选，用于document上传 */
-    uploadConf?: (businessType: number) => Promise<ApiResponse>;
     /** 日期格式化函数 - 必需，支持 util.date.format 或 util.filter.format */
     dateFormat: (date: Date, format: string) => string;
     /** 消息提示函数 - 可选 */
     messageWarning?: (msg: string) => void;
 }
-/**
- * 生成随机字符串
- * @param length 字符串长度
- * @returns 随机字符串
- */
-declare function randomString(length: number): string;
 /**
  * 阿里云OSS上传类
  * 整合所有项目的aliOss业务逻辑，通过依赖注入实现业务API解耦
  */
 export declare class AliOssClass {
     private apiConfig;
-    private clientCache;
     constructor(apiConfig: AliOssApiConfig);
     /**
-     * 创建OSS客户端
+     * 判断文件是否为图片（支持常见图片格式）
+     * @param {File} file - 上传的File对象
+     * @returns {boolean} 是否为图片
+     */
+    isImageFile(file: File): boolean;
+    /**
+     * 通过V4签名上传
+     * @param file 上传的文件
      * @param businessType 业务类型
-     * @param imggeCarType 车辆图片类型（可选，用于特定业务）
-     * @returns OSS客户端实例
+     * @param size 文件的尺寸
+     * @param resolve Promse
+     * @param reject Promse
+     * @returns 上传图片结果
      */
-    createOssClient(businessType: number, imggeCarType?: any): Promise<any>;
+    upload(params: {
+        file: any;
+        businessType: BusinessType;
+        size?: string;
+        resolve?: Function;
+        reject?: Function;
+        callbacks?: any;
+    }): Promise<{}>;
     /**
      * 预加载图片获取尺寸
      * @param file 文件对象
      * @returns 图片对象
      */
-    imgUpload(file: File): Promise<HTMLImageElement>;
-    /**
-     * 生成文件名
-     * @param imageType 图片类型
-     * @param extension 文件扩展名
-     * @returns 文件名信息
-     */
-    private generateFileName;
+    getImageInfo(file: File): Promise<HTMLImageElement>;
     /**
      * 检查图片是否为长图
-     * @param width 图片宽度
-     * @param height 图片高度
+     * @param File 图片
      * @returns 是否为长图
      */
     private isLongImage;
-    /**
-     * 执行OSS上传
-     * @param client OSS客户端
-     * @param fileName 文件名
-     * @param file 文件对象
-     * @param year 年份
-     * @param mimeType MIME类型
-     * @param onProgress 进度回调
-     * @returns 上传结果
-     */
-    private performOssUpload;
-    /**
-     * 确定业务类型
-     * @param option 上传选项
-     * @param isGif 是否为GIF
-     * @returns 业务类型
-     */
-    private determineBusinessType;
     /**
      * 加载图片并返回结果
      * 用于标准的图片上传场景
      * @param params 加载参数
      */
     loadImage(params: {
-        url: string;
-        val: any;
-        suffix: string;
-        file: File;
-        option: UploadOption;
-        resolve: (value: any) => void;
-        reject: (reason?: any) => void;
-        isGif?: boolean;
-    }): void;
-    /**
-     * 加载图片并返回结果（新版）
-     * 用于avatar、idCard等特殊场景，返回格式不同
-     * @param params 加载参数
-     */
-    loadImageNew(params: {
         url: string;
         val: any;
         file: File;
@@ -271,29 +264,19 @@ export declare class AliOssClass {
      */
     ossUploadFile: (option: UploadOption) => Promise<any>;
     /**
-     * 商品详情图片上传
-     * 注释：此方法用于商品详情页的图片上传，不压缩，使用NoWater客户端
+     * 纯图片上传 pureOssUploadImage
+     * 注释：图片上传，不压缩
      * @param option 上传选项
      * @returns Promise
      */
-    shopDetailUpdate: (option: UploadOption) => Promise<any>;
+    pureOssUploadImage: (option: UploadOption) => Promise<any>;
     /**
-     * 生成随机字符串
-     * @param num 字符串长度
-     */
-    randomString: typeof randomString;
-    /**
-     * 后缀枚举
+     * 商品详情图片上传（不建议直接使用，请使用 pureOssUploadImage）
+     * 注释：图片上传，不压缩
+     * @param option 上传选项
+     * @returns Promise
      */
-    suffixEnum: {
-        readonly nowater: "!nowater";
-        readonly official: "!official";
-        readonly panoram: "!panoram";
-        readonly forum: "!forum";
-        readonly avatar: "!avatar";
-        readonly square: "!square";
-        readonly carport: "!carport";
-    };
+    shopDetailUpdate: (option: UploadOption) => Promise<any>;
     /**
      * 业务类型枚举
      */
@@ -311,14 +294,5 @@ export declare function createAliOssUploader(apiConfig: AliOssApiConfig): AliOss
 declare const _default: {
     createAliOssUploader: typeof createAliOssUploader;
     BusinessType: typeof BusinessType;
-    SuffixEnum: {
-        readonly nowater: "!nowater";
-        readonly official: "!official";
-        readonly panoram: "!panoram";
-        readonly forum: "!forum";
-        readonly avatar: "!avatar";
-        readonly square: "!square";
-        readonly carport: "!carport";
-    };
 };
 export default _default;