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

package/dist/file-upload/interfaces/file-buffer.interface.d.ts

@@ -0,0 +1,72 @@
+/** 文件缓冲区接口 */
+export interface FileBuffer {
+    /** 文件二进制内容 */
+    buffer: Buffer;
+    /** 文件大小（字节） */
+    size: number;
+    /** MIME类型 */
+    mimeType: string;
+    /** 原始文件名 */
+    originalName: string;
+    /** 文件编码 */
+    encoding?: string;
+    /** 文件哈希值（SHA-256） */
+    hash?: string;
+    /** 文件流（适用于大文件） */
+    stream?: NodeJS.ReadableStream;
+    /** 分片信息（用于分片上传） */
+    chunk?: {
+        index: number;
+        total: number;
+        size: number;
+        start: number;
+        end: number;
+    };
+    /** 临时文件路径（用于大文件） */
+    tempPath?: string;
+    /** 上传进度回调 */
+    onProgress?: (progress: UploadProgress) => void;
+}
+/** 上传进度 */
+export interface UploadProgress {
+    /** 已上传字节数 */
+    loaded: number;
+    /** 总字节数 */
+    total: number;
+    /** 上传百分比 */
+    percentage: number;
+    /** 上传速度（字节/秒） */
+    speed: number;
+    /** 剩余时间（秒） */
+    eta: number;
+    /** 当前状态 */
+    status: 'uploading' | 'paused' | 'completed' | 'error';
+    /** 错误信息 */
+    error?: string;
+}
+/** 文件块 */
+export interface FileChunk {
+    /** 块索引 */
+    index: number;
+    /** 块数据 */
+    data: Buffer;
+    /** 块大小 */
+    size: number;
+    /** 块哈希 */
+    hash?: string;
+    /** 块在文件中的起始位置 */
+    offset: number;
+}
+/** 文件流选项 */
+export interface FileStreamOptions {
+    /** 分块大小 */
+    chunkSize?: number;
+    /** 是否使用缓冲 */
+    useBuffer?: boolean;
+    /** 缓冲区大小 */
+    bufferSize?: number;
+    /** 是否自动清理临时文件 */
+    autoCleanup?: boolean;
+    /** 临时文件目录 */
+    tempDir?: string;
+}

package/dist/file-upload/interfaces/file-entity.interface.d.ts

@@ -0,0 +1,142 @@
+/** 文件状态枚举 */
+export declare enum FileStatus {
+    UPLOADING = "uploading",
+    PROCESSING = "processing",
+    READY = "ready",
+    FAILED = "failed",
+    DELETED = "deleted",
+    QUARANTINED = "quarantined"
+}
+export interface FileEntity {
+    /** 唯一标识符 */
+    id: string;
+    /** 原始文件名 */
+    originalName: string;
+    /** 存储的文件名（经过安全处理） */
+    fileName: string;
+    /** MIME类型 */
+    mimeType: string;
+    /** 文件大小（字节） */
+    size: number;
+    /** 文件哈希值（SHA-256） */
+    hash: string;
+    /** 使用的存储提供者 */
+    storage: string;
+    /** 存储路径/键 */
+    path: string;
+    /** 公开访问URL（如果可公开访问） */
+    url?: string;
+    /** 文件元数据 */
+    metadata?: FileEntityMetadata;
+    /** 上传者ID */
+    uploadedBy?: string;
+    /** 上传时间 */
+    uploadedAt: Date;
+    /** 文件状态 */
+    status: FileStatus;
+    /** 是否已删除（软删除） */
+    isDeleted?: boolean;
+    /** 删除时间 */
+    deletedAt?: Date;
+    /** 文件版本号 */
+    version?: number;
+    /** 标签 */
+    tags?: string[];
+    /** 父级文件ID（用于版本管理） */
+    parentFileId?: string;
+    /** 所属文件集合ID */
+    collectionId?: string;
+    /** 访问次数 */
+    accessCount?: number;
+    /** 最后访问时间 */
+    lastAccessedAt?: Date;
+    /** 过期时间 */
+    expiresAt?: Date;
+    /** 存储提供商返回的额外信息 */
+    providerMetadata?: Record<string, any>;
+}
+/** 文件实体元数据 */
+export interface FileEntityMetadata {
+    /** 文件类型分类 */
+    category?: FileCategory;
+    /** 文件扩展名 */
+    extension?: string;
+    /** 文件编码 */
+    encoding?: string;
+    /** 宽度（适用于图片/视频） */
+    width?: number;
+    /** 高度（适用于图片/视频） */
+    height?: number;
+    /** 持续时间（适用于音频/视频） */
+    duration?: number;
+    /** 页数（适用于文档） */
+    pages?: number;
+    /** DPI（适用于图片） */
+    dpi?: number;
+    /** 色彩模式（适用于图片） */
+    colorMode?: string;
+    /** 压缩率 */
+    compressionRatio?: number;
+    /** EXIF信息（适用于图片） */
+    exif?: Record<string, any>;
+    /** 自定义元数据 */
+    custom?: Record<string, any>;
+}
+/** 文件分类 */
+export declare enum FileCategory {
+    IMAGE = "image",
+    VIDEO = "video",
+    AUDIO = "audio",
+    DOCUMENT = "document",
+    SPREADSHEET = "spreadsheet",
+    PRESENTATION = "presentation",
+    ARCHIVE = "archive",
+    CODE = "code",
+    TEXT = "text",
+    BINARY = "binary",
+    OTHER = "other"
+}
+/** 文件集合 */
+export interface FileCollection {
+    /** 集合ID */
+    id: string;
+    /** 集合名称 */
+    name: string;
+    /** 集合描述 */
+    description?: string;
+    /** 包含的文件列表 */
+    files?: FileEntity[];
+    /** 集合所有者 */
+    ownerId?: string;
+    /** 创建时间 */
+    createdAt?: Date;
+    /** 更新时间 */
+    updatedAt?: Date;
+    /** 是否公开 */
+    isPublic?: boolean;
+    /** 访问密码 */
+    password?: string;
+    /** 下载限制 */
+    downloadLimit?: number;
+    /** 过期时间 */
+    expiresAt?: Date;
+    /** 集合配置 */
+    settings?: CollectionSettings;
+}
+/** 集合设置 */
+export interface CollectionSettings {
+    /** 是否允许添加文件 */
+    allowAddFiles?: boolean;
+    /** 是否允许删除文件 */
+    allowDeleteFiles?: boolean;
+    /** 是否允许下载 */
+    allowDownload?: boolean;
+    /** 是否需要密码访问 */
+    requirePassword?: boolean;
+    /** 生成ZIP包 */
+    generateZip?: boolean;
+    /** 最大文件数 */
+    maxFiles?: number;
+    /** 最大总大小 */
+    maxTotalSize?: number;
+}

package/dist/file-upload/interfaces/file-entity.interface.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileCategory = exports.FileStatus = void 0;
+/** 文件状态枚举 */
+var FileStatus;
+(function (FileStatus) {
+    FileStatus["UPLOADING"] = "uploading";
+    FileStatus["PROCESSING"] = "processing";
+    FileStatus["READY"] = "ready";
+    FileStatus["FAILED"] = "failed";
+    FileStatus["DELETED"] = "deleted";
+    FileStatus["QUARANTINED"] = "quarantined";
+})(FileStatus || (exports.FileStatus = FileStatus = {}));
+/** 文件分类 */
+var FileCategory;
+(function (FileCategory) {
+    FileCategory["IMAGE"] = "image";
+    FileCategory["VIDEO"] = "video";
+    FileCategory["AUDIO"] = "audio";
+    FileCategory["DOCUMENT"] = "document";
+    FileCategory["SPREADSHEET"] = "spreadsheet";
+    FileCategory["PRESENTATION"] = "presentation";
+    FileCategory["ARCHIVE"] = "archive";
+    FileCategory["CODE"] = "code";
+    FileCategory["TEXT"] = "text";
+    FileCategory["BINARY"] = "binary";
+    FileCategory["OTHER"] = "other";
+})(FileCategory || (exports.FileCategory = FileCategory = {}));

package/dist/file-upload/interfaces/file-metadata.interface.d.ts

@@ -0,0 +1,21 @@
+/** 文件元数据接口 */
+export interface FileMetadata {
+    /** 文件大小 */
+    size: number;
+    /** MIME类型 */
+    mimeType: string;
+    /** 最后修改时间 */
+    lastModified: Date;
+    /** ETag */
+    etag?: string;
+    /** 文件扩展名 */
+    extension?: string;
+    /** 文件编码 */
+    encoding?: string;
+    /** 宽度（像素）- 适用于图片、视频 */
+    width?: number;
+    /** 高度（像素）- 适用于图片、视频 */
+    height?: number;
+    /** 自定义元数据 */
+    metadata?: Record<string, any>;
+}

package/dist/file-upload/interfaces/file-processor.interface.d.ts

@@ -0,0 +1,93 @@
+import { FileEntity } from './file-entity.interface';
+import { ProcessOptions, ProcessResult } from './processor-options.interface';
+/**
+ * 文件处理器基础接口
+ */
+export interface IFileProcessor {
+    /** 处理器名称 */
+    readonly name: string;
+    /** 支持的MIME类型 */
+    readonly supportedTypes: string[];
+    /**
+     * 验证文件是否可以被此处理器处理
+     * @param buffer 文件缓冲区
+     * @returns 是否支持
+     */
+    validate(buffer: Buffer): Promise<boolean>;
+    /**
+     * 处理文件
+     * @param file 文件实体
+     * @param options 处理选项
+     * @returns 处理结果
+     */
+    process(file: FileEntity, options: ProcessOptions): Promise<ProcessResult>;
+    /**
+     * 获取处理器信息（可选）
+     */
+    getInfo?(): ProcessorInfo;
+    /**
+     * 清理资源（可选）
+     */
+    cleanup?(): Promise<void>;
+    /**
+     * 健康检查（可选）
+     */
+    healthCheck?(): Promise<boolean>;
+}
+/**
+ * 处理器信息
+ */
+export interface ProcessorInfo {
+    /** 处理器名称 */
+    name: string;
+    /** 处理器版本 */
+    version: string;
+    /** 处理器描述 */
+    description: string;
+    /** 支持的文件类型 */
+    supportedTypes: string[];
+    /** 支持的文件扩展名 */
+    supportedExtensions: string[];
+    /** 处理器能力 */
+    capabilities: ProcessorCapabilities;
+    /** 性能指标 */
+    performance?: {
+        /** 最大文件大小（字节） */
+        maxFileSize?: number;
+        /** 平均处理时间（毫秒/MB） */
+        avgProcessTime?: number;
+        /** 内存使用量（MB） */
+        memoryUsage?: number;
+    };
+    /** 配置选项 */
+    configOptions?: Record<string, {
+        type: string;
+        description: string;
+        required?: boolean;
+        default?: any;
+        enum?: any[];
+    }>;
+}
+/**
+ * 处理器能力
+ */
+export interface ProcessorCapabilities {
+    /** 是否支持读取 */
+    read: boolean;
+    /** 是否支持写入 */
+    write: boolean;
+    /** 是否支持转换 */
+    transform: boolean;
+    /** 是否支持批量处理 */
+    batch: boolean;
+    /** 是否支持流式处理 */
+    stream: boolean;
+    /** 是否支持实时处理 */
+    realtime: boolean;
+    /** 是否支持并行处理 */
+    parallel: boolean;
+    /** 是否支持压缩 */
+    compress: boolean;
+    /** 是否支持加密 */
+    encrypt: boolean;
+}

package/dist/file-upload/interfaces/file-upload-options.interface.d.ts

@@ -0,0 +1,74 @@
+import { FileType } from '../enums/file-type.enum';
+import { Request } from 'express';
+/**
+ * 文件上传选项
+ */
+export interface FileUploadOptions {
+    /** 文件大小限制（字节），默认 10MB */
+    maxSize?: number;
+    /** 允许的文件类型（FileType 枚举或 MIME 类型） */
+    types?: Array<FileType | string>;
+    /** 允许的扩展名 */
+    exts?: string[];
+    /** 需要认证 */
+    auth?: boolean;
+    /** 需要文件所有权 */
+    ownership?: boolean;
+    /** 公开访问 */
+    public?: boolean;
+    /** 病毒扫描: true=强制, false=禁用, 'auto'=智能（默认） */
+    scan?: boolean | 'auto';
+    /** 文件名清理，默认 true */
+    sanitize?: boolean;
+    /** 保留原始文件名（默认 false，使用 UUID）*/
+    preserveOriginalName?: boolean;
+    /** 是否启用文件签名验证（默认 true） */
+    validateSignature?: boolean;
+    /** 是否启用恶意文件检测 */
+    maliciousCheck?: boolean;
+    image?: {
+        /** 调整大小 */
+        resize?: {
+            width: number;
+            height: number;
+            fit?: 'cover' | 'contain' | 'fill' | 'inside' | 'outside';
+        };
+        /** 压缩质量 0-100 */
+        quality?: number;
+        /** 输出格式 */
+        format?: 'jpeg' | 'png' | 'webp';
+        /** 水印文字 */
+        watermark?: string;
+        /** 生成缩略图 */
+        thumbnail?: boolean;
+    };
+    processor?: string | {
+        name: string;
+        options?: any;
+    };
+    /** 处理器选项（会与 processor.options 合并） */
+    processorOptions?: any;
+    /** 存储提供者: 'local' | 's3' | 'oss' | 'minio' */
+    storage?: string;
+    /** 自定义存储路径 */
+    path?: string;
+    /** 上传前钩子 */
+    before?: (file: Express.Multer.File, context: UploadContext) => Promise<void>;
+    /** 上传后钩子 */
+    after?: (file: Express.Multer.File, context: UploadContext) => Promise<void>;
+}
+/**
+ * 上传上下文
+ */
+export interface UploadContext {
+    /** 共享数据 */
+    shared: Record<string, any>;
+    /** 获取处理器 */
+    getProcessor(name: string): any | null;
+    /** 保存文件元数据 */
+    saveMetadata(fileId: string, metadata: any): Promise<void>;
+    /** 获取当前用户 */
+    getUser(): any;
+    /** 获取请求对象 */
+    getRequest(): Request;
+}

package/dist/file-upload/interfaces/file-upload-options.interface.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// 注意：IFileProcessor 已移至 file-processor.interface.ts，避免重复定义
+// 注意：ExcelDataOptions 已移至 excel-import.decorator.ts，避免重复定义
+// 注意：CsvDataOptions 已移至 csv-import.decorator.ts，避免重复定义

package/dist/file-upload/interfaces/index.d.ts

@@ -0,0 +1,7 @@
+export * from './file-entity.interface';
+export * from './storage-provider.interface';
+export * from './file-buffer.interface';
+export * from './file-metadata.interface';
+export * from './upload-options.interface';
+export * from './file-upload-options.interface';
+export * from './custom-file-type.interface';

package/dist/file-upload/interfaces/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Core interfaces
+__exportStar(require("./file-entity.interface"), exports);
+__exportStar(require("./storage-provider.interface"), exports);
+__exportStar(require("./file-buffer.interface"), exports);
+__exportStar(require("./file-metadata.interface"), exports);
+__exportStar(require("./upload-options.interface"), exports);
+__exportStar(require("./file-upload-options.interface"), exports);
+__exportStar(require("./custom-file-type.interface"), exports);

package/dist/file-upload/interfaces/processor-options.interface.d.ts

@@ -0,0 +1,102 @@
+/**
+ * 处理器通用选项
+ */
+export interface ProcessOptions {
+    /** 文件存储路径或标识 */
+    storageKey?: string;
+    /** 是否异步处理 */
+    async?: boolean;
+    /** 超时时间（毫秒） */
+    timeout?: number;
+    /** 处理优先级 */
+    priority?: 'low' | 'normal' | 'high' | 'urgent';
+    /** 重试次数 */
+    retries?: number;
+    /** 是否保存中间结果 */
+    saveIntermediate?: boolean;
+    /** 处理标签 */
+    tags?: string[];
+    /** 处理完成后是否删除原文件 */
+    deleteAfterProcess?: boolean;
+}
+/**
+ * 处理器通用结果
+ */
+export interface ProcessResult {
+    /** 是否成功 */
+    success: boolean;
+    /** 处理后的数据 */
+    data?: any;
+    /** 错误信息 */
+    error?: Error;
+    /**
+     * 要保存到 file_metadata 表的元数据
+     * 处理器可以通过返回这个字段来指定要保存的内容
+     * 如果不设置，将保存整个 result 对象
+     *
+     * @example
+     * // Excel/CSV 处理器示例
+     * return {
+     *   success: true,
+     *   data: parsedData,
+     *   metadata: {
+     *     data: parsedData,
+     *     headers: ['col1', 'col2'],
+     *     rowCount: 100,
+     *     columnCount: 5,
+     *     successCount: 98,
+     *     errorCount: 2,
+     *   }
+     * };
+     *
+     * @example
+     * // PDF 处理器示例
+     * return {
+     *   success: true,
+     *   data: extractedText,
+     *   metadata: {
+     *     text: extractedText,
+     *     pageCount: 10,
+     *     wordCount: 5000,
+     *     language: 'en',
+     *   }
+     * };
+     */
+    metadata?: Record<string, any>;
+    /** 其他元数据（旧字段，建议使用 metadata 字段） */
+    metadata_legacy?: {
+        /** 处理耗时（毫秒） */
+        duration?: number;
+        /** 处理器名称 */
+        processor?: string;
+        /** 处理时间 */
+        processedAt?: Date;
+        /** 文件大小 */
+        fileSize?: number;
+        /** 其他元数据 */
+        [key: string]: any;
+    };
+    /** 额外信息 */
+    extras?: {
+        /** 警告信息 */
+        warnings?: string[];
+        /** 建议操作 */
+        suggestions?: string[];
+        /** 关联的文件ID */
+        relatedFiles?: string[];
+        /** 处理日志 */
+        logs?: Array<{
+            timestamp: Date;
+            level: 'debug' | 'info' | 'warn' | 'error';
+            message: string;
+            data?: any;
+        }>;
+        /** 性能指标 */
+        metrics?: {
+            memoryUsage?: number;
+            cpuUsage?: number;
+            throughput?: number;
+            [key: string]: number;
+        };
+    };
+}