@haluo/util 2.0.27 → 2.0.29

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

@@ -1,291 +1,291 @@
-/**
- * @file 阿里云OSS上传统一工具类 v4
- * @description 整合所有项目的aliOss业务逻辑，通过传参形式支持不同业务场景
- * @Author: wanghui
- * @createBy: @2025.11.17
- *
- * 使用示例：
- * ```typescript
- * import { createAliOssUploader } from '@haluo/util'
- *
- * // 创建上传实例，传入业务相关的API函数
- * const ossUploader = createAliOssUploader({
- *   getSts: (params) => api.getSts(params),
- *   darkWaterUploadImage: (params) => api.darkWaterUploadImage(params),
- *   multiTransferImage: (params) => api.multiTransferImage(params),
- *   generatePrePresignedUrl: (params) => api.generatePrePresignedUrl(params),
- *   messageWarning: (msg) => window.$message.warning(msg)
- * })
- *
- * // 图片上传
- * ossUploader.ossUploadImage({
- *   file: file,
- *   businessType: 1500, // 业务类型 BusinessType
- *   imageType: 'official', // nowater、official、panoram、forum、avatar、square、carport
- *   quality: 0.7, // 压缩质量
- *   batchTransfer: false, // 是否批量转换水印
- *   notCompress: false, // 是否不压缩
- *   idCard: false, // 是否身份证上传
- *   onProgress: (e) => console.log(e.percent),
- *   onSuccess: (val) => console.log(val),
- *   onError: (err) => console.error(err)
- * })
- *
- * // 文件上传
- * ossUploader.ossUploadFile({
- *   file: file,
- *   businessType: 1500, // 业务类型 BusinessType
- *   onProgress: (e) => console.log(e.percent),
- *   onSuccess: (val) => console.log(val),
- *   onError: (err) => console.error(err)
- * })
- * ```
- */
-/**
- * 业务类型枚举
- */
-export declare enum BusinessType {
-    /** 客户端上传图片(跟用户相关) */
-    /** 隐私图片 */
-    CREDIT = 130541736,
-    /** 内容 */
-    CONTENT = 101300784,
-    /** 头像 */
-    AVATAR = 134539448,
-    /** 二手车 */
-    USEDCAR = 171978237,
-    /** 商城 */
-    MALL = 115259415,
-    /** 魔友圈 */
-    HOOP = 155669648,
-    /** 用户 */
-    USER = 170244368,
-    /** 骑行 */
-    CYCLING = 165103952,
-    /** 玩车 */
-    MOTORCYCLE = 151637735,
-    /** 租车 */
-    RENTALCAR = 149095014,
-    /** 经销商 */
-    SHOP = 172655993,
-    /** 财务 */
-    FINANCE = 188717541,
-    /** 反馈 */
-    FEEDBACK = 182411383,
-    /** 驾校 */
-    DRIVINGSCHOOL = 172137757,
-    /** 评论图片 */
-    REPLY = 195929698,
-    /** 厂家 */
-    FACTORY = 118733601,
-    /** 骑行数据 */
-    CYCLINGDATA = 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";
-    readonly official: "!official";
-    readonly panoram: "!panoram";
-    readonly forum: "!forum";
-    readonly avatar: "!avatar";
-    readonly square: "!square";
-    readonly carport: "!carport";
-};
-/** 图片类型 */
-export type ImageType = keyof typeof SuffixEnum;
-/**
- * 上传结果接口
- */
-export interface UploadResult {
-    imgUrl: string;
-    imgOrgUrl: string;
-    fileName: string;
-    name: string;
-    url?: string;
-    bucket?: string;
-    [key: string]: any;
-}
-/**
- * 上传选项接口
- */
-export interface UploadOption {
-    file: File;
-    businessType: BusinessType | number;
-    imageType?: ImageType | string;
-    quality?: number;
-    batchTransfer?: boolean;
-    notCompress?: boolean;
-    idCard?: boolean;
-    onProgress?: (e: {
-        percent: number;
-    }) => void;
-    onSuccess?: (val: UploadResult) => void;
-    onError?: (err: string) => void;
-}
-/**
- * API响应接口
- */
-interface ApiResponse<T = any> {
-    data: {
-        code: number;
-        data: T;
-    };
-}
-/**
- * API函数配置接口
- * 业务相关的API通过此接口传入，实现业务逻辑解耦
- */
-export interface AliOssApiConfig {
-    /** 获取STS，POST V4签名独有的表单元素- 必需 */
-    /** businessType: 业务编码(必传), docType: 文件格式如png(必传)，size: _1024_567(可选) */
-    getSts: (params: {
-        businessType: BusinessType;
-        docType: string;
-        size?: string;
-    }) => any;
-    /** 暗水印上传接口 - 可选，用于carport类型 */
-    darkWaterUploadImage?: (params: {
-        file: File;
-    }) => Promise<ApiResponse<string>>;
-    /** 批量转换水印接口 - 可选，用于batchTransfer */
-    multiTransferImage?: (params: {
-        file: File;
-    }) => Promise<ApiResponse<string>>;
-    /** 生成预签名URL接口 - 可选，用于idCard */
-    generatePrePresignedUrl?: (params: {
-        objectId: string;
-        expireMils: number;
-    }) => Promise<ApiResponse<string>>;
-    /** 消息提示函数 - 可选 */
-    messageWarning?: (msg: string) => void;
-}
-/**
- * 阿里云OSS上传类
- * 整合所有项目的aliOss业务逻辑，通过依赖注入实现业务API解耦
- */
-export declare class AliOssClass {
-    private static instance;
-    private apiConfig;
-    private constructor();
-    static getInstance(apiConfig: AliOssApiConfig): AliOssClass;
-    /**
-     * 判断文件是否为图片（支持常见图片格式）
-     * @param {File} file - 上传的File对象
-     * @returns {boolean} 是否为图片
-     */
-    isImageFile(file: File): boolean;
-    /**
-     * 通过V4签名上传
-     * @param file 上传的文件
-     * @param businessType 业务类型
-     * @param size 文件的尺寸
-     * @param resolve Promse
-     * @param reject Promse
-     * @returns 上传图片结果
-     */
-    upload(params: {
-        file: any;
-        businessType: BusinessType;
-        size?: string;
-        resolve?: Function;
-        reject?: Function;
-        callbacks?: any;
-    }): Promise<{}>;
-    /**
-     * 预加载图片获取尺寸
-     * @param file 文件对象
-     * @returns 图片对象
-     */
-    getImageInfo(file: File): Promise<HTMLImageElement>;
-    /**
-     * 检查图片是否为长图
-     * @param File 图片
-     * @returns 是否为长图
-     */
-    private isLongImage;
-    /**
-     * 加载图片并返回结果
-     * 用于标准的图片上传场景
-     * @param params 加载参数
-     */
-    loadImage(params: {
-        url: string;
-        val: any;
-        file: File;
-        option: UploadOption;
-        resolve: (value: any) => void;
-        reject: (reason?: any) => void;
-    }): void;
-    /**
-     * 图片上传主方法
-     * 整合了所有项目的图片上传逻辑
-     * @param option 上传选项
-     * @returns Promise
-     */
-    ossUploadImage: (option: UploadOption) => Promise<any>;
-    /**
-     * 文件上传方法
-     * 支持视频、文档、APK等文件类型
-     * @param option 上传选项
-     * @returns Promise
-     */
-    ossUploadFile: (option: UploadOption) => Promise<any>;
-    /**
-     * 纯图片上传 pureOssUploadImage
-     * 注释：图片上传，不压缩
-     * @param option 上传选项
-     * @returns Promise
-     */
-    pureOssUploadImage: (option: UploadOption) => Promise<any>;
-    /**
-     * 商品详情图片上传（不建议直接使用，请使用 pureOssUploadImage）
-     * 注释：图片上传，不压缩
-     * @param option 上传选项
-     * @returns Promise
-     */
-    shopDetailUpdate: (option: UploadOption) => Promise<any>;
-    /**
-     * 业务类型枚举
-     */
-    businessType: typeof BusinessType;
-}
-/**
- * 创建阿里云OSS上传器（工厂函数）
- * @param apiConfig API配置对象，包含业务相关的API函数
- * @returns OSS上传器实例
- */
-export declare function createAliOssUploader(apiConfig: AliOssApiConfig): AliOssClass;
-/**
- * 默认导出
- */
-declare const _default: {
-    createAliOssUploader: typeof createAliOssUploader;
-    BusinessType: typeof BusinessType;
-};
-export default _default;
+/**
+ * @file 阿里云OSS上传统一工具类 v4
+ * @description 整合所有项目的aliOss业务逻辑，通过传参形式支持不同业务场景
+ * @Author: wanghui
+ * @createBy: @2025.11.17
+ *
+ * 使用示例：
+ * ```typescript
+ * import { createAliOssUploader } from '@haluo/util'
+ *
+ * // 创建上传实例，传入业务相关的API函数
+ * const ossUploader = createAliOssUploader({
+ *   getSts: (params) => api.getSts(params),
+ *   darkWaterUploadImage: (params) => api.darkWaterUploadImage(params),
+ *   multiTransferImage: (params) => api.multiTransferImage(params),
+ *   generatePrePresignedUrl: (params) => api.generatePrePresignedUrl(params),
+ *   messageWarning: (msg) => window.$message.warning(msg)
+ * })
+ *
+ * // 图片上传
+ * ossUploader.ossUploadImage({
+ *   file: file,
+ *   businessType: BusinessType.CONTENT, // 业务类型 BusinessType
+ *   imageType: 'official', // nowater、official、panoram、forum、avatar、square、carport
+ *   quality: 0.7, // 压缩质量
+ *   batchTransfer: false, // 是否批量转换水印
+ *   notCompress: false, // 是否不压缩
+ *   idCard: false, // 是否身份证上传
+ *   onProgress: (e) => console.log(e.percent),
+ *   onSuccess: (val) => console.log(val),
+ *   onError: (err) => console.error(err)
+ * })
+ *
+ * // 文件上传
+ * ossUploader.ossUploadFile({
+ *   file: file,
+ *   businessType: BusinessType.CONTENT, // 业务类型 BusinessType
+ *   onProgress: (e) => console.log(e.percent),
+ *   onSuccess: (val) => console.log(val),
+ *   onError: (err) => console.error(err)
+ * })
+ * ```
+ */
+/**
+ * 业务类型枚举
+ */
+export declare enum BusinessType {
+    /** 客户端上传图片(跟用户相关) */
+    /** 隐私图片 */
+    CREDIT = 130541736,
+    /** 内容 */
+    CONTENT = 101300784,
+    /** 头像 */
+    AVATAR = 134539448,
+    /** 二手车 */
+    USEDCAR = 171978237,
+    /** 商城 */
+    MALL = 115259415,
+    /** 魔友圈 */
+    HOOP = 155669648,
+    /** 用户 */
+    USER = 170244368,
+    /** 骑行 */
+    CYCLING = 165103952,
+    /** 玩车 */
+    MOTORCYCLE = 151637735,
+    /** 租车 */
+    RENTALCAR = 149095014,
+    /** 经销商 */
+    SHOP = 172655993,
+    /** 财务 */
+    FINANCE = 188717541,
+    /** 反馈 */
+    FEEDBACK = 182411383,
+    /** 驾校 */
+    DRIVINGSCHOOL = 172137757,
+    /** 评论图片 */
+    REPLY = 195929698,
+    /** 厂家 */
+    FACTORY = 118733601,
+    /** 骑行数据 */
+    CYCLINGDATA = 148681294,
+    /** 动图 */
+    GIF = 191290831,
+    /** 其他（原则上不可以使用） */
+    OTHER = 100694193,
+    /** 运营文件(跟用户无关) */
+    /** apk */
+    APK = 154033062,
+    /** 证书 */
+    CERT = 142668067,
+    /** oss数据文件（xlxs等） */
+    OSSDATA = 105038102,
+    /** 数据（题库等） */
+    DB = 180241065,
+    /** PDF */
+    PDF = 198157532,
+    /** 视频 */
+    VIDEOOPS = 172023381,
+    /** 运营图片(跟用户无关) */
+    /** 商城运营图片 */
+    MALLOPS = 175705586,
+    /** 运营图片 */
+    OSSOPS = 157532694,
+    /** 车库运营图片 */
+    CARPORT = 137563987
+}
+/**
+ * bucket 图片类型后缀枚举
+ */
+export declare const SuffixEnum: {
+    readonly nowater: "!nowater";
+    readonly official: "!official";
+    readonly panoram: "!panoram";
+    readonly forum: "!forum";
+    readonly avatar: "!avatar";
+    readonly square: "!square";
+    readonly carport: "!carport";
+};
+/** 图片类型 */
+export type ImageType = keyof typeof SuffixEnum;
+/**
+ * 上传结果接口
+ */
+export interface UploadResult {
+    imgUrl: string;
+    imgOrgUrl: string;
+    fileName: string;
+    name: string;
+    url?: string;
+    bucket?: string;
+    [key: string]: any;
+}
+/**
+ * 上传选项接口
+ */
+export interface UploadOption {
+    file: File;
+    businessType: BusinessType | number;
+    imageType?: ImageType | string;
+    quality?: number;
+    batchTransfer?: boolean;
+    notCompress?: boolean;
+    idCard?: boolean;
+    onProgress?: (e: {
+        percent: number;
+    }) => void;
+    onSuccess?: (val: UploadResult) => void;
+    onError?: (err: string) => void;
+}
+/**
+ * API响应接口
+ */
+interface ApiResponse<T = any> {
+    data: {
+        code: number;
+        data: T;
+    };
+}
+/**
+ * API函数配置接口
+ * 业务相关的API通过此接口传入，实现业务逻辑解耦
+ */
+export interface AliOssApiConfig {
+    /** 获取STS，POST V4签名独有的表单元素- 必需 */
+    /** businessType: 业务编码(必传), docType: 文件格式如png(必传)，size: _1024_567(可选) */
+    getSts: (params: {
+        businessType: BusinessType;
+        docType: string;
+        size?: string;
+    }) => any;
+    /** 暗水印上传接口 - 可选，用于carport类型 */
+    darkWaterUploadImage?: (params: {
+        file: File;
+    }) => Promise<ApiResponse<string>>;
+    /** 批量转换水印接口 - 可选，用于batchTransfer */
+    multiTransferImage?: (params: {
+        file: File;
+    }) => Promise<ApiResponse<string>>;
+    /** 生成预签名URL接口 - 可选，用于idCard */
+    generatePrePresignedUrl?: (params: {
+        objectId: string;
+        expireMils: number;
+    }) => Promise<ApiResponse<string>>;
+    /** 消息提示函数 - 可选 */
+    messageWarning?: (msg: string) => void;
+}
+/**
+ * 阿里云OSS上传类
+ * 整合所有项目的aliOss业务逻辑，通过依赖注入实现业务API解耦
+ */
+export declare class AliOssClass {
+    private static instance;
+    private apiConfig;
+    private constructor();
+    static getInstance(apiConfig: AliOssApiConfig): AliOssClass;
+    /**
+     * 判断文件是否为图片（支持常见图片格式）
+     * @param {File} file - 上传的File对象
+     * @returns {boolean} 是否为图片
+     */
+    isImageFile(file: File): boolean;
+    /**
+     * 通过V4签名上传
+     * @param file 上传的文件
+     * @param businessType 业务类型
+     * @param size 文件的尺寸
+     * @param resolve Promse
+     * @param reject Promse
+     * @returns 上传图片结果
+     */
+    upload(params: {
+        file: any;
+        businessType: BusinessType;
+        size?: string;
+        resolve?: Function;
+        reject?: Function;
+        callbacks?: any;
+    }): Promise<{}>;
+    /**
+     * 预加载图片获取尺寸
+     * @param file 文件对象
+     * @returns 图片对象
+     */
+    getImageInfo(file: File): Promise<HTMLImageElement>;
+    /**
+     * 检查图片是否为长图
+     * @param File 图片
+     * @returns 是否为长图
+     */
+    private isLongImage;
+    /**
+     * 加载图片并返回结果
+     * 用于标准的图片上传场景
+     * @param params 加载参数
+     */
+    loadImage(params: {
+        url: string;
+        val: any;
+        file: File;
+        option: UploadOption;
+        resolve: (value: any) => void;
+        reject: (reason?: any) => void;
+    }): void;
+    /**
+     * 图片上传主方法
+     * 整合了所有项目的图片上传逻辑
+     * @param option 上传选项
+     * @returns Promise
+     */
+    ossUploadImage: (option: UploadOption) => Promise<any>;
+    /**
+     * 文件上传方法
+     * 支持视频、文档、APK等文件类型
+     * @param option 上传选项
+     * @returns Promise
+     */
+    ossUploadFile: (option: UploadOption) => Promise<any>;
+    /**
+     * 纯图片上传 pureOssUploadImage
+     * 注释：图片上传，不压缩
+     * @param option 上传选项
+     * @returns Promise
+     */
+    pureOssUploadImage: (option: UploadOption) => Promise<any>;
+    /**
+     * 商品详情图片上传（不建议直接使用，请使用 pureOssUploadImage）
+     * 注释：图片上传，不压缩
+     * @param option 上传选项
+     * @returns Promise
+     */
+    shopDetailUpdate: (option: UploadOption) => Promise<any>;
+    /**
+     * 业务类型枚举
+     */
+    businessType: typeof BusinessType;
+}
+/**
+ * 创建阿里云OSS上传器（工厂函数，内部已实现单例）
+ * @param apiConfig API配置对象，包含业务相关的API函数
+ * @returns OSS上传器实例
+ */
+export declare function createAliOssUploader(apiConfig: AliOssApiConfig): AliOssClass;
+/**
+ * 默认导出
+ */
+declare const _default: {
+    createAliOssUploader: typeof createAliOssUploader;
+    BusinessType: typeof BusinessType;
+};
+export default _default;