@haluo/util 2.0.23 → 2.0.24

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

@@ -1,321 +0,0 @@
-/**
- * @file 阿里云OSS上传统一工具类
- * @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),
- *   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)
- * })
- *
- * // 图片上传
- * ossUploader.ossUploadImage({
- *   file: file,
- *   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, // 是否身份证上传
- *   onProgress: (e) => console.log(e.percent),
- *   onSuccess: (val) => console.log(val),
- *   onError: (err) => console.error(err)
- * })
- *
- * // 文件上传
- * ossUploader.ossUploadFile({
- *   file: file,
- *   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)
- * })
- * ```
- */
-/**
- * 业务类型枚举
- * 不同的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
-}
-/**
- * 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;
-/**
- * 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;
-    url?: string;
-    fileName?: string;
-    name?: string;
-    bucket?: string;
-    [key: string]: any;
-}
-/**
- * 上传选项接口
- */
-export interface UploadOption {
-    file: File;
-    imageType?: ImageType | string;
-    quality?: number;
-    businessType?: BusinessType | number;
-    batchTransfer?: boolean;
-    notCompress?: boolean;
-    idCard?: boolean;
-    isVideo?: boolean;
-    isUnProtect?: boolean;
-    isDocument?: 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临时凭证 - 必需 */
-    getAliyunSts: (params: {
-        businessType: number;
-    }) => Promise<ApiResponse<OSSClientParams>>;
-    /** 暗水印上传接口 - 可选，用于carport类型 */
-    darkWaterUploadImage?: (params: {
-        file: File;
-    }) => Promise<ApiResponse<string>>;
-    /** 批量转换水印接口 - 可选，用于batchTransfer */
-    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 businessType 业务类型
-     * @returns OSS客户端实例
-     */
-    createOssClient(businessType: number): Promise<any>;
-    /**
-     * 预加载图片获取尺寸
-     * @param file 文件对象
-     * @returns 图片对象
-     */
-    imgUpload(file: File): Promise<HTMLImageElement>;
-    /**
-     * 生成文件名
-     * @param imageType 图片类型
-     * @param extension 文件扩展名
-     * @returns 文件名信息
-     */
-    private generateFileName;
-    /**
-     * 检查图片是否为长图
-     * @param width 图片宽度
-     * @param height 图片高度
-     * @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;
-        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>;
-    /**
-     * 商品详情图片上传
-     * 注释：此方法用于商品详情页的图片上传，不压缩，使用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;
-/**
- * 默认导出
- */
-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;