@haluo/util 2.0.1 → 2.0.2-0.1

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

@@ -0,0 +1,12 @@
+/**
+ * @file aliOss 使用示例
+ * @description 展示如何在项目中使用统一的 aliOss 工具
+ */
+declare const basicOssUploader: import("./aliOss").AliOssClass;
+declare const fullOssUploader: import("./aliOss").AliOssClass;
+declare function uploadNormalImage(file: File): Promise<any>;
+declare function uploadAvatar(file: File): Promise<any>;
+declare function uploadVideo(file: File): Promise<any>;
+declare function uploadIdCard(file: File): Promise<any>;
+declare function uploadShopDetail(file: File): Promise<any>;
+export { basicOssUploader, fullOssUploader, uploadNormalImage, uploadAvatar, uploadVideo, uploadIdCard, uploadShopDetail };

package/dist/modules/upload/ALIOSS_EXAMPLE.js

@@ -0,0 +1,320 @@
+"use strict";
+/**
+ * @file aliOss 使用示例
+ * @description 展示如何在项目中使用统一的 aliOss 工具
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadShopDetail = exports.uploadIdCard = exports.uploadVideo = exports.uploadAvatar = exports.uploadNormalImage = exports.fullOssUploader = exports.basicOssUploader = void 0;
+var aliOss_1 = require("./aliOss");
+// ============================================
+// 示例1：基础配置（最小配置）
+// ============================================
+var basicOssUploader = (0, aliOss_1.createAliOssUploader)({
+    // 必需：获取阿里云STS临时凭证
+    getAliyunSts: function (params) { return __awaiter(void 0, void 0, void 0, function () {
+        var response;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, fetch('/api/getAliyunSts', {
+                        method: 'POST',
+                        body: JSON.stringify(params)
+                    })];
+                case 1:
+                    response = _a.sent();
+                    return [2 /*return*/, response.json()];
+            }
+        });
+    }); },
+    // 必需：日期格式化函数
+    dateFormat: function (date, format) {
+        // 简单实现，实际项目中使用 util.date.format 或 util.filter.format
+        var year = date.getFullYear();
+        var month = String(date.getMonth() + 1).padStart(2, '0');
+        var day = String(date.getDate()).padStart(2, '0');
+        var hour = String(date.getHours()).padStart(2, '0');
+        var minute = String(date.getMinutes()).padStart(2, '0');
+        var second = String(date.getSeconds()).padStart(2, '0');
+        return format
+            .replace('YYYY', String(year))
+            .replace('MM', month)
+            .replace('DD', day)
+            .replace('HH', hour)
+            .replace('mm', minute)
+            .replace('ss', second);
+    },
+    // 可选：消息提示
+    messageWarning: function (msg) {
+        console.warn(msg);
+        // 或使用你的消息组件：window.$message.warning(msg)
+    }
+});
+exports.basicOssUploader = basicOssUploader;
+// ============================================
+// 示例2：完整配置（OSS后台项目）
+// ============================================
+var fullOssUploader = (0, aliOss_1.createAliOssUploader)({
+    getAliyunSts: function (params) { return __awaiter(void 0, void 0, void 0, function () {
+        var response;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, fetch('/api/getAliyunSts', {
+                        method: 'POST',
+                        body: JSON.stringify(params)
+                    })];
+                case 1:
+                    response = _a.sent();
+                    return [2 /*return*/, response.json()];
+            }
+        });
+    }); },
+    // 暗水印上传
+    darkWaterUploadImage: function (params) { return __awaiter(void 0, void 0, void 0, function () {
+        var formData, response;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    formData = new FormData();
+                    formData.append('file', params.file);
+                    return [4 /*yield*/, fetch('/api/darkWaterUploadImage', {
+                            method: 'POST',
+                            body: formData
+                        })];
+                case 1:
+                    response = _a.sent();
+                    return [2 /*return*/, response.json()];
+            }
+        });
+    }); },
+    // 批量转换水印
+    multiTransferImage: function (params) { return __awaiter(void 0, void 0, void 0, function () {
+        var formData, response;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    formData = new FormData();
+                    formData.append('file', params.file);
+                    return [4 /*yield*/, fetch('/api/multiTransferImage', {
+                            method: 'POST',
+                            body: formData
+                        })];
+                case 1:
+                    response = _a.sent();
+                    return [2 /*return*/, response.json()];
+            }
+        });
+    }); },
+    // 头像处理
+    aliyunPersist: function (params) { return __awaiter(void 0, void 0, void 0, function () {
+        var response;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, fetch('/api/aliyunPersist', {
+                        method: 'POST',
+                        body: JSON.stringify(params)
+                    })];
+                case 1:
+                    response = _a.sent();
+                    return [2 /*return*/, response.json()];
+            }
+        });
+    }); },
+    // 生成预签名URL
+    generatePrePresignedUrl: function (params) { return __awaiter(void 0, void 0, void 0, function () {
+        var response;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, fetch('/api/generatePrePresignedUrl', {
+                        method: 'GET'
+                    })];
+                case 1:
+                    response = _a.sent();
+                    return [2 /*return*/, response.json()];
+            }
+        });
+    }); },
+    // 上传配置
+    uploadConf: function (businessType) { return __awaiter(void 0, void 0, void 0, function () {
+        var response;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, fetch("/api/uploadConf?businessType=".concat(businessType))];
+                case 1:
+                    response = _a.sent();
+                    return [2 /*return*/, response.json()];
+            }
+        });
+    }); },
+    dateFormat: function (date, format) {
+        // 日期格式化实现
+        return format;
+    },
+    messageWarning: function (msg) {
+        console.warn(msg);
+    }
+});
+exports.fullOssUploader = fullOssUploader;
+// ============================================
+// 使用示例
+// ============================================
+// 1. 普通图片上传
+function uploadNormalImage(file) {
+    return __awaiter(this, void 0, void 0, function () {
+        var result, error_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 2, , 3]);
+                    return [4 /*yield*/, basicOssUploader.ossUploadImage({
+                            file: file,
+                            imageType: 'official',
+                            quality: 0.7,
+                            onProgress: function (e) {
+                                console.log("\u4E0A\u4F20\u8FDB\u5EA6: ".concat(e.percent, "%"));
+                            },
+                            onSuccess: function (val) {
+                                console.log('上传成功:', val.imgUrl);
+                            },
+                            onError: function (err) {
+                                console.error('上传失败:', err);
+                            }
+                        })];
+                case 1:
+                    result = _a.sent();
+                    return [2 /*return*/, result];
+                case 2:
+                    error_1 = _a.sent();
+                    console.error('上传异常:', error_1);
+                    return [3 /*break*/, 3];
+                case 3: return [2 /*return*/];
+            }
+        });
+    });
+}
+exports.uploadNormalImage = uploadNormalImage;
+// 2. 头像上传
+function uploadAvatar(file) {
+    return __awaiter(this, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, fullOssUploader.ossUploadImage({
+                        file: file,
+                        imageType: 'avatar',
+                        quality: 0.8,
+                        businessType: aliOss_1.BusinessType.AVATAR,
+                        onSuccess: function (val) {
+                            console.log('头像上传成功:', val.imgUrl);
+                        }
+                    })];
+                case 1:
+                    result = _a.sent();
+                    return [2 /*return*/, result];
+            }
+        });
+    });
+}
+exports.uploadAvatar = uploadAvatar;
+// 3. 视频上传
+function uploadVideo(file) {
+    return __awaiter(this, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, fullOssUploader.ossUploadFile({
+                        file: file,
+                        isVideo: true,
+                        onProgress: function (e) {
+                            console.log("\u89C6\u9891\u4E0A\u4F20\u8FDB\u5EA6: ".concat(e.percent, "%"));
+                        },
+                        onSuccess: function (val) {
+                            console.log('视频上传成功:', val.url);
+                        }
+                    })];
+                case 1:
+                    result = _a.sent();
+                    return [2 /*return*/, result];
+            }
+        });
+    });
+}
+exports.uploadVideo = uploadVideo;
+// 4. 身份证上传（私有）
+function uploadIdCard(file) {
+    return __awaiter(this, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, fullOssUploader.ossUploadImage({
+                        file: file,
+                        imageType: 'official',
+                        idCard: true,
+                        businessType: aliOss_1.BusinessType.PRIVATE,
+                        onSuccess: function (val) {
+                            console.log('身份证上传成功:', val.imgUrl);
+                        }
+                    })];
+                case 1:
+                    result = _a.sent();
+                    return [2 /*return*/, result];
+            }
+        });
+    });
+}
+exports.uploadIdCard = uploadIdCard;
+// 5. 商品详情图片上传
+function uploadShopDetail(file) {
+    return __awaiter(this, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, fullOssUploader.shopDetailUpdate({
+                        file: file,
+                        imageType: 'official',
+                        onSuccess: function (val) {
+                            console.log('商品详情图片上传成功:', val.imgUrl);
+                        }
+                    })];
+                case 1:
+                    result = _a.sent();
+                    return [2 /*return*/, result];
+            }
+        });
+    });
+}
+exports.uploadShopDetail = uploadShopDetail;

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

@@ -0,0 +1,324 @@
+/**
+ * @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
+}
+/**
+ * 图片类型后缀枚举
+ */
+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;
+    imggeCarType?: any;
+    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;
+        imggeCarType?: any;
+    }) => 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 业务类型
+     * @param imggeCarType 车辆图片类型（可选，用于特定业务）
+     * @returns OSS客户端实例
+     */
+    createOssClient(businessType: number, imggeCarType?: any): 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;