@nest-omni/core 4.1.3-11 → 4.1.3-12

package/file-upload/controllers/file-access.controller.js

@@ -0,0 +1,128 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+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 FileAccessController_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileAccessController = void 0;
+const common_1 = require("@nestjs/common");
+const file_service_1 = require("../services/file.service");
+/**
+ * 文件访问控制器
+ * 提供文件下载和预览功能
+ * 注意：Controller 仅负责 HTTP 层逻辑，业务逻辑在 FileService
+ */
+let FileAccessController = FileAccessController_1 = class FileAccessController {
+    constructor(fileService) {
+        this.fileService = fileService;
+        this.logger = new common_1.Logger(FileAccessController_1.name);
+    }
+    /**
+     * 通过文件 ID 下载/访问文件
+     * GET /files/:id
+     */
+    getFile(id, res) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // 从数据库获取文件记录
+            const fileEntity = yield this.fileService.findById(id);
+            if (!fileEntity) {
+                throw new common_1.NotFoundException(`文件不存在: ${id}`);
+            }
+            // 检查文件是否可访问
+            if (fileEntity.status !== 'completed') {
+                throw new common_1.NotFoundException(`文件尚未准备就绪: ${id}`);
+            }
+            // 对象存储：重定向到预签名 URL
+            if (['s3', 'oss', 'minio', 'cdn'].includes(fileEntity.storageProvider)) {
+                try {
+                    const signedUrl = yield this.fileService.getSignedUrl(id);
+                    res.redirect(302, signedUrl);
+                    return;
+                }
+                catch (error) {
+                    this.logger.error(`Failed to get signed URL for file ${id}: ${error.message}`);
+                    throw new common_1.NotFoundException(`无法访问文件: ${id}`);
+                }
+            }
+            // 本地存储：流式返回
+            if (fileEntity.storageProvider === 'local') {
+                try {
+                    const stream = yield this.fileService.getFileStream(id);
+                    res.set({
+                        'Content-Type': fileEntity.mimeType,
+                        'Content-Length': fileEntity.size.toString(),
+                    });
+                    return new common_1.StreamableFile(stream);
+                }
+                catch (error) {
+                    this.logger.error(`Failed to stream file ${id}: ${error.message}`);
+                    throw new common_1.NotFoundException(`无法访问文件: ${id}`);
+                }
+            }
+            // 不支持的存储类型
+            throw new common_1.NotFoundException(`不支持的存储类型: ${fileEntity.storageProvider}`);
+        });
+    }
+    /**
+     * 通过文件 ID 下载文件（强制下载）
+     * GET /files/:id/download
+     */
+    downloadFile(id, res) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const fileEntity = yield this.fileService.findById(id);
+            if (!fileEntity) {
+                throw new common_1.NotFoundException(`文件不存在: ${id}`);
+            }
+            if (fileEntity.status !== 'completed') {
+                throw new common_1.NotFoundException(`文件尚未准备就绪: ${id}`);
+            }
+            // 设置下载响应头
+            res.set({
+                'Content-Disposition': `attachment; filename="${encodeURIComponent(fileEntity.originalName)}"`,
+            });
+            // 复用 getFile 逻辑
+            return this.getFile(id, res);
+        });
+    }
+};
+exports.FileAccessController = FileAccessController;
+__decorate([
+    (0, common_1.Get)(':id'),
+    (0, common_1.Header)('Cache-Control', 'public, max-age=31536000') // 缓存1年
+    ,
+    __param(0, (0, common_1.Param)('id')),
+    __param(1, (0, common_1.Res)({ passthrough: true })),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object]),
+    __metadata("design:returntype", Promise)
+], FileAccessController.prototype, "getFile", null);
+__decorate([
+    (0, common_1.Get)(':id/download'),
+    __param(0, (0, common_1.Param)('id')),
+    __param(1, (0, common_1.Res)({ passthrough: true })),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object]),
+    __metadata("design:returntype", Promise)
+], FileAccessController.prototype, "downloadFile", null);
+exports.FileAccessController = FileAccessController = FileAccessController_1 = __decorate([
+    (0, common_1.Controller)('files'),
+    __metadata("design:paramtypes", [file_service_1.FileService])
+], FileAccessController);

package/file-upload/decorators/csv-data.decorator.d.ts

@@ -0,0 +1,44 @@
+import { CsvDataOptions } from '../interfaces/file-upload-options.interface';
+/**
+ * CSV 列映射元数据键
+ */
+export declare const CSV_COLUMN_METADATA = "csv:column";
+/**
+ * CSV 列名映射装饰器
+ * @example
+ * ```typescript
+ * export class OrderImportDto {
+ *   @CsvColumn('订单号')
+ *   @IsString()
+ *   orderNo: string;
+ * }
+ * ```
+ */
+export declare function CsvColumn(columnName: string): PropertyDecorator;
+/**
+ * CSV 数据参数装饰器
+ * @example
+ * ```typescript
+ * @Post('import/csv')
+ * @FileUpload({ types: [FileType.CSV] })
+ * async importCsv(@CsvData(OrderImportDto) orders: OrderImportDto[]) {
+ *   await this.orderService.batchCreate(orders);
+ *   return { count: orders.length };
+ * }
+ * ```
+ */
+export declare const CsvData: (...dataOrPipes: (import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>> | {
+    dto: any;
+    options?: CsvDataOptions;
+})[]) => ParameterDecorator;
+/**
+ * 辅助函数：获取 DTO 的 CSV 列映射
+ */
+export declare function getCsvColumnMapping(dto: any): Map<string, string>;
+/**
+ * 辅助函数：解析和验证 CSV 数据
+ */
+export declare function parseAndValidateCsvData<T extends object>(rawData: any[], dtoClass: new () => T, options?: CsvDataOptions): Promise<{
+    data: T[];
+    errors: any[];
+}>;

package/file-upload/decorators/csv-data.decorator.js

@@ -0,0 +1,131 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CsvData = exports.CSV_COLUMN_METADATA = void 0;
+exports.CsvColumn = CsvColumn;
+exports.getCsvColumnMapping = getCsvColumnMapping;
+exports.parseAndValidateCsvData = parseAndValidateCsvData;
+const common_1 = require("@nestjs/common");
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+/**
+ * CSV 列映射元数据键
+ */
+exports.CSV_COLUMN_METADATA = 'csv:column';
+/**
+ * CSV 列名映射装饰器
+ * @example
+ * ```typescript
+ * export class OrderImportDto {
+ *   @CsvColumn('订单号')
+ *   @IsString()
+ *   orderNo: string;
+ * }
+ * ```
+ */
+function CsvColumn(columnName) {
+    return (target, propertyKey) => {
+        Reflect.defineMetadata(exports.CSV_COLUMN_METADATA, columnName, target, propertyKey);
+    };
+}
+/**
+ * CSV 数据参数装饰器
+ * @example
+ * ```typescript
+ * @Post('import/csv')
+ * @FileUpload({ types: [FileType.CSV] })
+ * async importCsv(@CsvData(OrderImportDto) orders: OrderImportDto[]) {
+ *   await this.orderService.batchCreate(orders);
+ *   return { count: orders.length };
+ * }
+ * ```
+ */
+exports.CsvData = (0, common_1.createParamDecorator)((data, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+    const request = ctx.switchToHttp().getRequest();
+    const file = request.file;
+    if (!file) {
+        throw new Error('No file uploaded');
+    }
+    // 这里将在 interceptor 中处理 CSV 解析
+    // 当前只返回文件信息，实际解析逻辑在 FileUploadInterceptor 中
+    return {
+        _csvData: true,
+        dto: data,
+        file,
+        options: data === null || data === void 0 ? void 0 : data['options'],
+    };
+}));
+/**
+ * 辅助函数：获取 DTO 的 CSV 列映射
+ */
+function getCsvColumnMapping(dto) {
+    const mapping = new Map();
+    const prototype = dto.prototype;
+    if (!prototype) {
+        return mapping;
+    }
+    const propertyKeys = Object.getOwnPropertyNames(prototype);
+    for (const propertyKey of propertyKeys) {
+        const columnName = Reflect.getMetadata(exports.CSV_COLUMN_METADATA, prototype, propertyKey);
+        if (columnName) {
+            mapping.set(columnName, propertyKey);
+        }
+    }
+    return mapping;
+}
+/**
+ * 辅助函数：解析和验证 CSV 数据
+ */
+function parseAndValidateCsvData(rawData_1, dtoClass_1) {
+    return __awaiter(this, arguments, void 0, function* (rawData, dtoClass, options = {}) {
+        const { skipEmptyLines = true, skipHeader = false } = options;
+        const data = [];
+        const errors = [];
+        const mapping = getCsvColumnMapping(dtoClass);
+        const startIndex = skipHeader ? 1 : 0;
+        for (let i = startIndex; i < rawData.length; i++) {
+            const row = rawData[i];
+            // 跳过空行
+            if (skipEmptyLines && isEmptyRow(row)) {
+                continue;
+            }
+            const obj = {};
+            // 映射列名到属性名
+            for (const [columnName, propertyKey] of mapping.entries()) {
+                obj[propertyKey] = row[columnName];
+            }
+            // 转换为 DTO 实例
+            const instance = (0, class_transformer_1.plainToInstance)(dtoClass, obj);
+            // 验证
+            const validationErrors = yield (0, class_validator_1.validate)(instance);
+            if (validationErrors.length > 0) {
+                errors.push({
+                    row: i + 1,
+                    data: obj,
+                    errors: validationErrors,
+                });
+            }
+            else {
+                data.push(instance);
+            }
+        }
+        return { data, errors };
+    });
+}
+/**
+ * 检查是否为空行
+ */
+function isEmptyRow(row) {
+    if (!row)
+        return true;
+    const values = Object.values(row);
+    return values.every((val) => !val || String(val).trim() === '');
+}

package/file-upload/decorators/excel-data.decorator.d.ts

@@ -0,0 +1,44 @@
+import { ExcelDataOptions } from '../interfaces/file-upload-options.interface';
+/**
+ * Excel 列映射元数据键
+ */
+export declare const EXCEL_COLUMN_METADATA = "excel:column";
+/**
+ * Excel 列名映射装饰器
+ * @example
+ * ```typescript
+ * export class UserImportDto {
+ *   @ExcelColumn('姓名')
+ *   @IsString()
+ *   name: string;
+ * }
+ * ```
+ */
+export declare function ExcelColumn(columnName: string): PropertyDecorator;
+/**
+ * Excel 数据参数装饰器
+ * @example
+ * ```typescript
+ * @Post('import/excel')
+ * @FileUpload({ types: [FileType.Excel] })
+ * async importExcel(@ExcelData(UserImportDto) users: UserImportDto[]) {
+ *   await this.userService.batchCreate(users);
+ *   return { count: users.length };
+ * }
+ * ```
+ */
+export declare const ExcelData: (...dataOrPipes: (import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>> | {
+    dto: any;
+    options?: ExcelDataOptions;
+})[]) => ParameterDecorator;
+/**
+ * 辅助函数：获取 DTO 的 Excel 列映射
+ */
+export declare function getExcelColumnMapping(dto: any): Map<string, string>;
+/**
+ * 辅助函数：解析和验证 Excel 数据
+ */
+export declare function parseAndValidateExcelData<T extends object>(rawData: any[], dtoClass: new () => T, options?: ExcelDataOptions): Promise<{
+    data: T[];
+    errors: any[];
+}>;

package/file-upload/decorators/excel-data.decorator.js

@@ -0,0 +1,125 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExcelData = exports.EXCEL_COLUMN_METADATA = void 0;
+exports.ExcelColumn = ExcelColumn;
+exports.getExcelColumnMapping = getExcelColumnMapping;
+exports.parseAndValidateExcelData = parseAndValidateExcelData;
+const common_1 = require("@nestjs/common");
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+/**
+ * Excel 列映射元数据键
+ */
+exports.EXCEL_COLUMN_METADATA = 'excel:column';
+/**
+ * Excel 列名映射装饰器
+ * @example
+ * ```typescript
+ * export class UserImportDto {
+ *   @ExcelColumn('姓名')
+ *   @IsString()
+ *   name: string;
+ * }
+ * ```
+ */
+function ExcelColumn(columnName) {
+    return (target, propertyKey) => {
+        Reflect.defineMetadata(exports.EXCEL_COLUMN_METADATA, columnName, target, propertyKey);
+    };
+}
+/**
+ * Excel 数据参数装饰器
+ * @example
+ * ```typescript
+ * @Post('import/excel')
+ * @FileUpload({ types: [FileType.Excel] })
+ * async importExcel(@ExcelData(UserImportDto) users: UserImportDto[]) {
+ *   await this.userService.batchCreate(users);
+ *   return { count: users.length };
+ * }
+ * ```
+ */
+exports.ExcelData = (0, common_1.createParamDecorator)((data, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+    const request = ctx.switchToHttp().getRequest();
+    const file = request.file;
+    if (!file) {
+        throw new Error('No file uploaded');
+    }
+    // 这里将在 interceptor 中处理 Excel 解析
+    // 当前只返回文件信息，实际解析逻辑在 FileUploadInterceptor 中
+    return {
+        _excelData: true,
+        dto: data,
+        file,
+        options: data === null || data === void 0 ? void 0 : data['options'],
+    };
+}));
+/**
+ * 辅助函数：获取 DTO 的 Excel 列映射
+ */
+function getExcelColumnMapping(dto) {
+    const mapping = new Map();
+    const prototype = dto.prototype;
+    if (!prototype) {
+        return mapping;
+    }
+    const propertyKeys = Object.getOwnPropertyNames(prototype);
+    for (const propertyKey of propertyKeys) {
+        const columnName = Reflect.getMetadata(exports.EXCEL_COLUMN_METADATA, prototype, propertyKey);
+        if (columnName) {
+            mapping.set(columnName, propertyKey);
+        }
+    }
+    return mapping;
+}
+/**
+ * 辅助函数：解析和验证 Excel 数据
+ */
+function parseAndValidateExcelData(rawData_1, dtoClass_1) {
+    return __awaiter(this, arguments, void 0, function* (rawData, dtoClass, options = {}) {
+        const { startRow = 1, maxRows, stopOnError = false } = options;
+        const data = [];
+        const errors = [];
+        const mapping = getExcelColumnMapping(dtoClass);
+        let rowsProcessed = 0;
+        for (let i = startRow; i < rawData.length; i++) {
+            if (maxRows && rowsProcessed >= maxRows) {
+                break;
+            }
+            const row = rawData[i];
+            const obj = {};
+            // 映射列名到属性名
+            for (const [columnName, propertyKey] of mapping.entries()) {
+                obj[propertyKey] = row[columnName];
+            }
+            // 转换为 DTO 实例
+            const instance = (0, class_transformer_1.plainToInstance)(dtoClass, obj);
+            // 验证
+            const validationErrors = yield (0, class_validator_1.validate)(instance);
+            if (validationErrors.length > 0) {
+                errors.push({
+                    row: i + 1,
+                    data: obj,
+                    errors: validationErrors,
+                });
+                if (stopOnError) {
+                    break;
+                }
+            }
+            else {
+                data.push(instance);
+            }
+            rowsProcessed++;
+        }
+        return { data, errors };
+    });
+}

package/file-upload/decorators/file-upload.decorator.d.ts

@@ -0,0 +1,83 @@
+import { FileUploadOptions } from '../interfaces/file-upload-options.interface';
+/**
+ * 文件上传装饰器元数据键
+ */
+export declare const FILE_UPLOAD_OPTIONS = "file_upload_options";
+/**
+ * 统一的文件上传装饰器
+ *
+ * @example
+ * ```typescript
+ * @Post('upload')
+ * @FileUpload({ types: [FileType.Image, FileType.PDF] })
+ * async upload(@UploadedFile() file: Express.Multer.File) {
+ *   return { url: file.path };
+ * }
+ * ```
+ */
+export declare function FileUpload(options?: FileUploadOptions): MethodDecorator;
+/**
+ * 静态快捷方法命名空间
+ */
+export declare namespace FileUpload {
+    /**
+     * 图片上传
+     * @example
+     * ```typescript
+     * @Post('photos')
+     * @FileUpload.Image()
+     * async uploadPhoto(@UploadedFile() file: Express.Multer.File) {
+     *   return { url: file.path };
+     * }
+     * ```
+     */
+    function Image(options?: Partial<FileUploadOptions>): MethodDecorator;
+    /**
+     * 头像上传（带默认图片处理）
+     * @example
+     * ```typescript
+     * @Post('users/:id/avatar')
+     * @FileUpload.Avatar()
+     * async uploadAvatar(@UploadedFile() file: Express.Multer.File) {
+     *   return { url: file.path };
+     * }
+     * ```
+     */
+    function Avatar(options?: Partial<FileUploadOptions>): MethodDecorator;
+    /**
+     * 文档上传
+     * @example
+     * ```typescript
+     * @Post('documents')
+     * @FileUpload.Document()
+     * async uploadDocument(@UploadedFile() file: Express.Multer.File) {
+     *   return { url: file.path };
+     * }
+     * ```
+     */
+    function Document(options?: Partial<FileUploadOptions>): MethodDecorator;
+    /**
+     * PDF 上传
+     */
+    function PDF(options?: Partial<FileUploadOptions>): MethodDecorator;
+    /**
+     * Excel 上传
+     */
+    function Excel(options?: Partial<FileUploadOptions>): MethodDecorator;
+    /**
+     * CSV 上传
+     */
+    function CSV(options?: Partial<FileUploadOptions>): MethodDecorator;
+    /**
+     * 视频上传
+     */
+    function Video(options?: Partial<FileUploadOptions>): MethodDecorator;
+    /**
+     * 音频上传
+     */
+    function Audio(options?: Partial<FileUploadOptions>): MethodDecorator;
+    /**
+     * 公开访问的文件上传
+     */
+    function Public(options?: Partial<FileUploadOptions>): MethodDecorator;
+}