@haluo/util 2.0.20 → 2.0.22

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

@@ -176,62 +176,64 @@ export interface AliOssApiConfig {
  */
 declare function randomString(length: number): string;
 /**
- * 创建阿里云OSS上传器
- * @param apiConfig API配置对象，包含业务相关的API函数
- * @returns OSS上传器实例
+ * 阿里云OSS上传类
+ * 整合所有项目的aliOss业务逻辑，通过依赖注入实现业务API解耦
  */
-export declare function createAliOssUploader(apiConfig: AliOssApiConfig): {
-    /**
-     * 图片上传
-     * @param option 上传选项
-     */
-    ossUploadImage: (option: UploadOption) => Promise<any>;
-    /**
-     * 文件上传（视频、文档、APK等）
-     * @param option 上传选项
-     */
-    ossUploadFile: (option: UploadOption) => Promise<any>;
+export declare class AliOssClass {
+    private apiConfig;
+    private clientCache;
+    constructor(apiConfig: AliOssApiConfig);
     /**
-     * 商品详情图片上传
-     * @param option 上传选项
+     * 创建OSS客户端
+     * @param businessType 业务类型
+     * @param imggeCarType 车辆图片类型（可选，用于特定业务）
+     * @returns OSS客户端实例
      */
-    shopDetailUpdate: (option: UploadOption) => Promise<any>;
+    createOssClient(businessType: number, imggeCarType?: any): Promise<any>;
     /**
-     * 后缀枚举
+     * 预加载图片获取尺寸
+     * @param file 文件对象
+     * @returns 图片对象
      */
-    suffixEnum: {
-        readonly nowater: "!nowater";
-        readonly official: "!official";
-        readonly panoram: "!panoram";
-        readonly forum: "!forum";
-        readonly avatar: "!avatar";
-        readonly square: "!square";
-        readonly carport: "!carport";
-    };
+    imgUpload(file: File): Promise<HTMLImageElement>;
     /**
-     * 业务类型枚举
+     * 生成文件名
+     * @param imageType 图片类型
+     * @param extension 文件扩展名
+     * @returns 文件名信息
      */
-    businessType: typeof BusinessType;
+    private generateFileName;
     /**
-     * 生成随机字符串
-     * @param num 字符串长度
+     * 检查图片是否为长图
+     * @param width 图片宽度
+     * @param height 图片高度
+     * @returns 是否为长图
      */
-    randomString: typeof randomString;
+    private isLongImage;
     /**
-     * 创建OSS客户端（高级用法）
-     * @param businessType 业务类型
-     * @param imggeCarType 车辆图片类型
+     * 执行OSS上传
+     * @param client OSS客户端
+     * @param fileName 文件名
+     * @param file 文件对象
+     * @param year 年份
+     * @param mimeType MIME类型
+     * @param onProgress 进度回调
+     * @returns 上传结果
      */
-    createOssClient: (businessType: number, imggeCarType?: any) => Promise<any>;
+    private performOssUpload;
     /**
-     * 预加载图片
-     * @param file 文件对象
+     * 确定业务类型
+     * @param option 上传选项
+     * @param isGif 是否为GIF
+     * @returns 业务类型
      */
-    imgUpload: (file: File) => Promise<HTMLImageElement>;
+    private determineBusinessType;
     /**
      * 加载图片并返回结果
+     * 用于标准的图片上传场景
+     * @param params 加载参数
      */
-    loadImage: (params: {
+    loadImage(params: {
         url: string;
         val: any;
         suffix: string;
@@ -239,20 +241,70 @@ export declare function createAliOssUploader(apiConfig: AliOssApiConfig): {
         option: UploadOption;
         resolve: (value: any) => void;
         reject: (reason?: any) => void;
-        isGif?: boolean | undefined;
-    }) => void;
+        isGif?: boolean;
+    }): void;
     /**
      * 加载图片并返回结果（新版）
+     * 用于avatar、idCard等特殊场景，返回格式不同
+     * @param params 加载参数
      */
-    loadImageNew: (params: {
+    loadImageNew(params: {
         url: string;
         val: any;
         file: File;
         option: UploadOption;
         resolve: (value: any) => void;
         reject: (reason?: any) => void;
-    }) => void;
-};
+    }): void;
+    /**
+     * 图片上传主方法
+     * 整合了所有项目的图片上传逻辑
+     * @param option 上传选项
+     * @returns Promise
+     */
+    ossUploadImage: (option: UploadOption) => Promise<any>;
+    /**
+     * 文件上传方法
+     * 支持视频、文档、APK等文件类型
+     * @param option 上传选项
+     * @returns Promise
+     */
+    ossUploadFile: (option: UploadOption) => Promise<any>;
+    /**
+     * 商品详情图片上传
+     * 注释：此方法用于商品详情页的图片上传，不压缩，使用NoWater客户端
+     * @param option 上传选项
+     * @returns Promise
+     */
+    shopDetailUpdate: (option: UploadOption) => Promise<any>;
+    /**
+     * 生成随机字符串
+     * @param num 字符串长度
+     */
+    randomString: typeof randomString;
+    /**
+     * 后缀枚举
+     */
+    suffixEnum: {
+        readonly nowater: "!nowater";
+        readonly official: "!official";
+        readonly panoram: "!panoram";
+        readonly forum: "!forum";
+        readonly avatar: "!avatar";
+        readonly square: "!square";
+        readonly carport: "!carport";
+    };
+    /**
+     * 业务类型枚举
+     */
+    businessType: typeof BusinessType;
+}
+/**
+ * 创建阿里云OSS上传器（工厂函数）
+ * @param apiConfig API配置对象，包含业务相关的API函数
+ * @returns OSS上传器实例
+ */
+export declare function createAliOssUploader(apiConfig: AliOssApiConfig): AliOssClass;
 /**
  * 默认导出
  */