sa2kit 1.0.0 → 1.0.2

package/dist/UniversalFileService-CEZRJ87g.d.mts

@@ -0,0 +1,727 @@
+import { EventEmitter } from 'events';
+
+/**
+ * 通用文件服务类型定义
+ *
+ * 定义了文件存储、上传、下载等核心接口和类型
+ */
+/** 文件存储类型 */
+type StorageType$1 = 'local' | 'aliyun-oss' | 'aws-s3' | 'qcloud-cos';
+/** CDN提供者类型 */
+type CDNType$1 = 'none' | 'aliyun-cdn' | 'aws-cloudfront' | 'qcloud-cdn';
+/** 文件处理类型 */
+type ProcessorType$1 = 'image' | 'audio' | 'video' | 'document';
+/** 文件上传状态 */
+type UploadStatus = 'pending' | 'uploading' | 'processing' | 'completed' | 'failed';
+/** 访问权限类型 */
+type AccessPermission = 'public' | 'private' | 'authenticated' | 'owner-only';
+/** 文件元数据基础接口 */
+interface FileMetadata {
+    /** 文件ID */
+    id: string;
+    /** 原始文件名 */
+    originalName: string;
+    /** 存储文件名 */
+    storageName: string;
+    /** 文件大小(字节) */
+    size: number;
+    /** MIME类型 */
+    mimeType: string;
+    /** 文件扩展名 */
+    extension: string;
+    /** 文件哈希值 */
+    hash?: string;
+    /** 上传时间 */
+    uploadTime: Date;
+    /** 访问权限 */
+    permission: AccessPermission;
+    /** 上传者ID */
+    uploaderId: string;
+    /** 模块标识 */
+    moduleId: string;
+    /** 业务标识 */
+    businessId?: string;
+    /** 存储提供者 */
+    storageProvider: StorageType$1;
+    /** 存储路径 */
+    storagePath: string;
+    /** CDN URL */
+    cdnUrl?: string;
+    /** 访问次数 */
+    accessCount: number;
+    /** 最后访问时间 */
+    lastAccessTime?: Date;
+    /** 过期时间 */
+    expiresAt?: Date;
+    /** 自定义元数据 */
+    metadata?: Record<string, any>;
+}
+/** 上传文件信息（客户端使用） */
+interface UploadFileInfo$1 {
+    /** 文件对象 */
+    file: File;
+    /** 模块标识 */
+    moduleId: string;
+    /** 业务标识 */
+    businessId?: string;
+    /** 访问权限 */
+    permission?: AccessPermission;
+    /** 自定义存储路径 */
+    customPath?: string;
+    /** 自定义元数据 */
+    metadata?: Record<string, any>;
+    /** 是否需要处理 */
+    needsProcessing?: boolean;
+    /** 处理选项 */
+    processingOptions?: ProcessingOptions$1;
+}
+/** 文件处理选项基础接口 */
+interface ProcessingOptions$1 {
+    /** 处理器类型 */
+    type: ProcessorType$1;
+    /** 处理参数 */
+    params?: Record<string, any>;
+}
+/** 图片处理选项 */
+interface ImageProcessingOptions extends ProcessingOptions$1 {
+    type: 'image';
+    /** 压缩质量 0-100 */
+    quality?: number;
+    /** 目标宽度 */
+    width?: number;
+    /** 目标高度 */
+    height?: number;
+    /** 格式转换 */
+    format?: 'jpeg' | 'png' | 'webp' | 'avif';
+    /** 是否添加水印 */
+    watermark?: boolean;
+    /** 水印配置 */
+    watermarkOptions?: {
+        text?: string;
+        image?: string;
+        position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'center';
+        opacity?: number;
+    };
+}
+/** 音频处理选项 */
+interface AudioProcessingOptions extends ProcessingOptions$1 {
+    type: 'audio';
+    /** 比特率 */
+    bitrate?: number;
+    /** 格式转换 */
+    format?: 'mp3' | 'wav' | 'ogg' | 'aac';
+    /** 采样率 */
+    sampleRate?: number;
+    /** 声道数 */
+    channels?: number;
+}
+/** 视频处理选项 */
+interface VideoProcessingOptions extends ProcessingOptions$1 {
+    type: 'video';
+    /** 视频质量 */
+    quality?: number;
+    /** 格式转换 */
+    format?: 'mp4' | 'avi' | 'mov' | 'webm';
+    /** 生成缩略图 */
+    generateThumbnail?: boolean;
+    /** 缩略图时间点(秒) */
+    thumbnailTime?: number;
+}
+/** 上传进度 */
+interface UploadProgress {
+    /** 文件ID */
+    fileId: string;
+    /** 上传状态 */
+    status: UploadStatus;
+    /** 进度百分比(0-100) */
+    progress: number;
+    /** 已上传字节数 */
+    uploadedBytes: number;
+    /** 总字节数 */
+    totalBytes: number;
+    /** 上传速度(字节/秒) */
+    speed: number;
+    /** 剩余时间(秒) */
+    remainingTime: number;
+    /** 错误信息 */
+    error?: string;
+}
+/** 上传结果 */
+interface UploadResult {
+    /** 是否成功 */
+    success: boolean;
+    /** 文件元数据 */
+    file?: FileMetadata;
+    /** 文件访问URL */
+    url?: string;
+    /** 错误信息 */
+    error?: string;
+}
+/** 文件查询选项 */
+interface FileQueryOptions$1 {
+    /** 模块标识 */
+    moduleId?: string;
+    /** 业务标识 */
+    businessId?: string;
+    /** 上传者ID */
+    uploaderId?: string;
+    /** MIME类型过滤 */
+    mimeType?: string;
+    /** 最小文件大小 */
+    minSize?: number;
+    /** 最大文件大小 */
+    maxSize?: number;
+    /** 开始时间 */
+    startTime?: Date;
+    /** 结束时间 */
+    endTime?: Date;
+    /** 搜索关键词 */
+    keyword?: string;
+    /** 标签 */
+    tags?: string[];
+    /** 排序字段 */
+    sortBy?: string;
+    /** 排序方向 */
+    sortOrder?: 'asc' | 'desc';
+    /** 页码 */
+    page?: number;
+    /** 每页数量 */
+    pageSize?: number;
+}
+/** 分页结果 */
+interface PaginatedResult$1<T> {
+    /** 数据项 */
+    items: T[];
+    /** 总数 */
+    total: number;
+    /** 当前页码 */
+    page: number;
+    /** 每页数量 */
+    pageSize: number;
+    /** 总页数 */
+    totalPages: number;
+    /** 是否有下一页 */
+    hasNext: boolean;
+    /** 是否有上一页 */
+    hasPrev: boolean;
+}
+/** 批量操作结果 */
+interface BatchOperationResult {
+    /** 成功数量 */
+    successCount: number;
+    /** 失败数量 */
+    failureCount: number;
+    /** 失败详情 */
+    failures: Array<{
+        fileId: string;
+        error: string;
+    }>;
+}
+/** 文件事件类型 */
+type FileEventType$1 = 'upload:start' | 'upload:progress' | 'upload:complete' | 'upload:error' | 'download:start' | 'download:complete' | 'download:error' | 'delete:complete' | 'processing:start' | 'processing:complete' | 'processing:error';
+/** 文件事件 */
+interface FileEvent$1 {
+    /** 事件类型 */
+    type: FileEventType$1;
+    /** 文件ID */
+    fileId: string;
+    /** 事件时间 */
+    timestamp: Date;
+    /** 事件数据 */
+    data?: Record<string, any>;
+    /** 错误信息 */
+    error?: string;
+}
+/** 文件事件监听器 */
+type FileEventListener$1 = (event: FileEvent$1) => void | Promise<void>;
+/** 文件服务基础异常 */
+declare class FileServiceError$1 extends Error {
+    readonly code: string;
+    readonly details?: Record<string, any> | undefined;
+    constructor(message: string, code: string, details?: Record<string, any> | undefined);
+}
+/** 文件上传错误 */
+declare class FileUploadError$1 extends FileServiceError$1 {
+    constructor(message: string, details?: Record<string, any>);
+}
+/** 文件处理错误 */
+declare class FileProcessingError$1 extends FileServiceError$1 {
+    constructor(message: string, details?: Record<string, any>);
+}
+/** 存储提供者错误 */
+declare class StorageProviderError$1 extends FileServiceError$1 {
+    constructor(message: string, details?: Record<string, any>);
+}
+/** CDN提供者错误 */
+declare class CDNProviderError$1 extends FileServiceError$1 {
+    constructor(message: string, details?: Record<string, any>);
+}
+
+/**
+ * UniversalFile Server 端类型定义
+ */
+
+type StorageType = StorageType$1;
+type CDNType = CDNType$1;
+type ProcessorType = ProcessorType$1;
+type UploadFileInfo = UploadFileInfo$1;
+type ProcessingOptions = ProcessingOptions$1;
+/** 存储提供者接口 */
+interface IStorageProvider {
+    /** 提供者类型 */
+    readonly type: StorageType;
+    /** 初始化 */
+    initialize(config: StorageConfig): Promise<void>;
+    /** 上传文件 */
+    upload(fileInfo: UploadFileInfo, path: string): Promise<StorageResult>;
+    /** 下载文件 */
+    download(path: string): Promise<Buffer>;
+    /** 删除文件 */
+    delete(path: string): Promise<StorageResult>;
+    /** 获取文件信息 */
+    getFileInfo(path: string): Promise<StorageResult>;
+    /** 生成访问URL */
+    getAccessUrl(path: string, expiresIn?: number): Promise<string>;
+    /** 生成预签名上传URL */
+    getUploadUrl(path: string, expiresIn?: number): Promise<string>;
+    /** 检查文件是否存在 */
+    exists(path: string): Promise<boolean>;
+    /** 列出文件 */
+    list(prefix: string, maxKeys?: number): Promise<string[]>;
+}
+/** CDN 提供者接口 */
+interface ICDNProvider {
+    /** 提供者类型 */
+    readonly type: CDNType;
+    /** 初始化 */
+    initialize(config: CDNConfig): Promise<void>;
+    /** 生成CDN URL */
+    generateUrl(originalUrl: string): Promise<string>;
+    /** 刷新缓存 */
+    refreshCache(urls: string[]): Promise<CDNResult>;
+    /** 预热缓存 */
+    preheatCache(urls: string[]): Promise<CDNResult>;
+    /** 获取访问统计 */
+    getAccessStats(startTime: Date, endTime: Date): Promise<CDNResult>;
+}
+/** 文件处理器接口 */
+interface IFileProcessor {
+    /** 处理器类型 */
+    readonly type: ProcessorType;
+    /** 初始化 */
+    initialize(): Promise<void>;
+    /** 处理文件 */
+    process(inputPath: string, outputPath: string, options: ProcessingOptions): Promise<ProcessingResult>;
+    /** 检查文件是否支持处理 */
+    supports(mimeType: string): boolean;
+    /** 获取文件信息 */
+    getFileInfo(filePath: string): Promise<Record<string, any>>;
+}
+/** 存储配置基础接口 */
+interface StorageConfig {
+    /** 存储类型 */
+    type: StorageType;
+    /** 是否启用 */
+    enabled: boolean;
+}
+/** 本地存储配置 */
+interface LocalStorageConfig extends StorageConfig {
+    type: 'local';
+    /** 存储根目录 */
+    rootPath: string;
+    /** 基础URL */
+    baseUrl: string;
+}
+/** 阿里云 OSS 配置 */
+interface AliyunOSSConfig extends StorageConfig {
+    type: 'aliyun-oss';
+    /** 地域 */
+    region: string;
+    /** 存储桶名称 */
+    bucket: string;
+    /** 访问密钥ID */
+    accessKeyId: string;
+    /** 访问密钥密码 */
+    accessKeySecret: string;
+    /** 自定义域名 */
+    customDomain?: string;
+    /** 是否使用HTTPS */
+    secure?: boolean;
+    /** 是否使用内网访问 */
+    internal?: boolean;
+}
+/** CDN配置基础接口 */
+interface CDNConfig {
+    /** CDN类型 */
+    type: CDNType;
+    /** 是否启用 */
+    enabled: boolean;
+}
+/** 阿里云 CDN 配置 */
+interface AliyunCDNConfig extends CDNConfig {
+    type: 'aliyun-cdn';
+    /** CDN域名 */
+    domain: string;
+    /** 访问密钥ID */
+    accessKeyId: string;
+    /** 访问密钥密码 */
+    accessKeySecret: string;
+    /** 地域 */
+    region?: string;
+}
+/** 缓存配置 */
+interface CacheConfig {
+    /** 是否启用缓存 */
+    enabled: boolean;
+    /** 最大缓存大小 */
+    maxSize?: number;
+    /** 缓存 TTL（秒） */
+    ttl?: number;
+    /** 是否使用 Redis */
+    useRedis?: boolean;
+    /** Redis 配置 */
+    redisConfig?: {
+        host: string;
+        port: number;
+        password?: string;
+        db?: number;
+    };
+}
+/** 文件服务配置 */
+/** 缓存配置扩展 */
+interface CacheConfig {
+    /** 是否启用缓存 */
+    enabled: boolean;
+    /** 元数据缓存TTL（秒） */
+    metadataTTL?: number;
+    /** URL缓存TTL（秒） */
+    urlTTL?: number;
+    /** 最大缓存条目数 */
+    maxSize?: number;
+}
+interface UniversalFileServiceConfig {
+    /** 存储配置 */
+    storage: StorageConfig;
+    /** CDN 配置（可选） */
+    cdn?: CDNConfig;
+    /** 缓存配置（可选） */
+    cache?: CacheConfig;
+    /** 数据库持久化配置（可选） */
+    persistence?: FileServicePersistenceConfig;
+    /** 启用的处理器 */
+    processors?: ProcessorType[];
+    /** 数据库连接（可选） @deprecated 使用 persistence.repository 代替 */
+    db?: any;
+    /** 最大文件大小（字节） */
+    maxFileSize?: number;
+    /** 允许的文件类型 */
+    allowedMimeTypes?: string[];
+    /** 是否启用监控 */
+    enableMonitoring?: boolean;
+    /** 存储提供者映射（内部使用） */
+    storageProviders?: Map<StorageType, IStorageProvider>;
+    /** 默认存储类型 */
+    defaultStorage?: StorageType;
+    /** 默认CDN类型 */
+    defaultCDN?: CDNType;
+}
+/** 存储结果 */
+/** 存储操作结果 */
+interface StorageResult {
+    /** 是否成功 */
+    success: boolean;
+    /** 存储路径 */
+    path?: string;
+    /** 访问URL */
+    url?: string;
+    /** 文件大小 */
+    size?: number;
+    /** 错误信息 */
+    error?: string;
+    /** 额外数据 */
+    data?: Record<string, any>;
+}
+/** 存储元数据 */
+interface StorageMetadata {
+    /** 文件大小 */
+    size: number;
+    /** MIME 类型 */
+    mimeType: string;
+    /** 最后修改时间 */
+    lastModified: Date;
+    /** 自定义元数据 */
+    metadata?: Record<string, any>;
+}
+/** CDN 结果 */
+/** CDN操作结果 */
+interface CDNResult {
+    /** 是否成功 */
+    success: boolean;
+    /** CDN URL */
+    url?: string;
+    /** 错误信息 */
+    error?: string;
+    /** 额外数据 */
+    data?: Record<string, any>;
+}
+/** CDN 统计信息 */
+interface CDNStats {
+    /** 带宽（字节/秒） */
+    bandwidth: number;
+    /** 请求数 */
+    requests: number;
+    /** 流量（字节） */
+    traffic: number;
+    /** 统计时间范围 */
+    timeRange: {
+        start: Date;
+        end: Date;
+    };
+}
+/** 处理结果 */
+interface ProcessingResult {
+    /** 是否成功 */
+    success: boolean;
+    /** 处理后的文件路径 */
+    processedPath?: string;
+    /** 处理后的文件大小 */
+    processedSize?: number;
+    /** 缩略图路径 */
+    thumbnailPath?: string;
+    /** 错误信息 */
+    error?: string;
+    /** 处理耗时(毫秒) */
+    processingTime?: number;
+    /** 额外数据 */
+    data?: Record<string, any>;
+}
+/** 处理器信息 */
+interface ProcessorInfo {
+    /** 处理器名称 */
+    name: string;
+    /** 处理器版本 */
+    version: string;
+    /** 支持的格式 */
+    supportedFormats: string[];
+    /** 支持的操作 */
+    supportedOperations: string[];
+}
+/** 文件数据库记录 */
+interface FileRecord extends FileMetadata {
+    /** 创建时间 */
+    createdAt: Date | string;
+    /** 更新时间 */
+    updatedAt: Date | string;
+}
+/** 文件查询选项 */
+interface FileQueryOptions {
+    /** 模块 ID */
+    moduleId?: string;
+    /** 业务 ID */
+    businessId?: string;
+    /** 上传者 ID */
+    uploaderId?: string;
+    /** 文件类型 */
+    mimeType?: string;
+    /** 访问权限 */
+    permission?: AccessPermission;
+    /** 状态 */
+    status?: UploadStatus;
+    /** 分页 */
+    page?: number;
+    pageSize?: number;
+    /** 排序 */
+    orderBy?: string;
+    orderDirection?: 'asc' | 'desc';
+}
+/** 分页结果 */
+interface PaginatedResult<T> {
+    /** 数据列表 */
+    items: T[];
+    /** 总数 */
+    total: number;
+    /** 当前页 */
+    page: number;
+    /** 每页大小 */
+    pageSize: number;
+    /** 总页数 */
+    totalPages: number;
+}
+/** 文件事件类型 */
+type FileEventType = 'upload:start' | 'upload:progress' | 'upload:complete' | 'upload:error' | 'download:start' | 'download:complete' | 'download:error' | 'delete:complete' | 'delete:error' | 'process:start' | 'process:complete' | 'process:error';
+/** 文件事件 */
+interface FileEvent {
+    /** 事件类型 */
+    type: FileEventType;
+    /** 文件 ID */
+    fileId: string;
+    /** 事件数据 */
+    data?: any;
+    /** 时间戳 */
+    timestamp: Date;
+}
+/** 事件监听器 */
+type FileEventListener = (event: FileEvent) => void | Promise<void>;
+/**
+ * 文件元数据数据库持久化接口
+ *
+ * 实现此接口以提供自定义的数据库持久化支持
+ *
+ * @example
+ * ```typescript
+ * // Drizzle ORM 实现
+ * class DrizzleFileRepository implements IFileMetadataRepository {
+ *   async save(metadata: FileMetadata): Promise<void> {
+ *     await db.insert(fileMetadata).values(metadata);
+ *   }
+ *   // ... 其他方法
+ * }
+ * ```
+ */
+interface IFileMetadataRepository {
+    /**
+     * 保存文件元数据到数据库
+     */
+    save(metadata: FileMetadata): Promise<void>;
+    /**
+     * 从数据库获取文件元数据
+     */
+    get(fileId: string): Promise<FileMetadata | null>;
+    /**
+     * 查询文件列表
+     */
+    query(options: FileQueryOptions): Promise<PaginatedResult<FileMetadata>>;
+    /**
+     * 从数据库删除文件元数据
+     */
+    delete(fileId: string): Promise<void>;
+    /**
+     * 批量删除文件元数据
+     */
+    batchDelete(fileIds: string[]): Promise<void>;
+}
+/**
+ * 数据库持久化配置
+ */
+interface FileServicePersistenceConfig {
+    /**
+     * 是否启用持久化
+     */
+    enabled: boolean;
+    /**
+     * 持久化仓储实现
+     */
+    repository: IFileMetadataRepository;
+    /**
+     * 是否自动持久化（默认 true）
+     * 如果为 true，文件上传完成后自动保存到数据库
+     */
+    autoPersist?: boolean;
+    /**
+     * 是否优先使用缓存（默认 false）
+     * 如果为 true，查询时优先从缓存获取
+     */
+    cacheFirst?: boolean;
+}
+/** 文件服务异常基类 */
+declare class FileServiceError extends Error {
+    readonly code: string;
+    readonly details?: Record<string, any> | undefined;
+    constructor(message: string, code: string, details?: Record<string, any> | undefined);
+}
+/** 文件上传异常 */
+declare class FileUploadError extends FileServiceError {
+    constructor(message: string, details?: Record<string, any>);
+}
+/** 文件处理异常 */
+declare class FileProcessingError extends FileServiceError {
+    constructor(message: string, details?: Record<string, any>);
+}
+/** 存储提供者异常 */
+declare class StorageProviderError extends FileServiceError {
+    constructor(message: string, details?: Record<string, any>);
+}
+/** CDN提供者异常 */
+declare class CDNProviderError extends FileServiceError {
+    constructor(message: string, details?: Record<string, any>);
+}
+
+/**
+ * 通用文件服务核心实现
+ *
+ * 提供统一的文件上传、下载、管理接口
+ */
+
+/**
+ * 通用文件服务类
+ */
+declare class UniversalFileService extends EventEmitter {
+    private config;
+    private storageProviders;
+    private cdnProviders;
+    private fileProcessors;
+    private uploadProgressMap;
+    private metadataCache;
+    private urlCache;
+    private processingQueue;
+    private isProcessingQueueRunning;
+    constructor(config: UniversalFileServiceConfig);
+    /**
+     * 设置数据库持久化监听器
+     *
+     * 当文件上传完成或删除时，自动触发数据库操作
+     */
+    private setupPersistenceListeners;
+    /**
+     * 初始化文件服务
+     */
+    initialize(): Promise<void>;
+    /**
+     * 重新初始化存储提供者（支持配置热更新）
+     */
+    reinitializeStorageProviders(): Promise<void>;
+    /**
+     * 注册存储提供者
+     */
+    registerStorageProvider(provider: IStorageProvider): void;
+    /**
+     * 注册CDN提供者
+     */
+    registerCDNProvider(provider: ICDNProvider): void;
+    /**
+     * 注册文件处理器
+     */
+    registerFileProcessor(processor: IFileProcessor): void;
+    /**
+     * 上传文件
+     */
+    uploadFile(fileInfo: UploadFileInfo$1, storageType?: StorageType$1, onProgress?: (progress: UploadProgress) => void): Promise<FileMetadata>;
+    /**
+     * 获取上传进度
+     */
+    getUploadProgress(fileId: string): UploadProgress | undefined;
+    /**
+     * 监听文件事件
+     */
+    onFileEvent(eventType: string, listener: FileEventListener$1): void;
+    /**
+     * 移除文件事件监听器
+     */
+    offFileEvent(eventType: string, listener: FileEventListener$1): void;
+    private initializeStorageProviders;
+    private registerDefaultStorageProviders;
+    private initializeCDNProviders;
+    private initializeFileProcessors;
+    private validateFile;
+    private generateFileMetadata;
+    private generateStoragePath;
+    private generateFileHash;
+    private queueFileProcessing;
+    private generateProcessedPath;
+    private processFileQueue;
+    private cacheMetadata;
+    private _clearMetadataCache2;
+    private emitFileEvent;
+}
+
+export { type FileEventType as $, type AccessPermission as A, type BatchOperationResult as B, CDNProviderError$1 as C, type IFileProcessor as D, type ProcessorType as E, type FileMetadata as F, type ProcessingOptions as G, type ProcessingResult as H, type ImageProcessingOptions as I, type IFileMetadataRepository as J, type AliyunOSSConfig as K, type AliyunCDNConfig as L, type LocalStorageConfig as M, type FileServicePersistenceConfig as N, type CacheConfig as O, type PaginatedResult$1 as P, type StorageMetadata as Q, type CDNStats as R, StorageProviderError$1 as S, type ProcessorInfo as T, type UploadFileInfo$1 as U, type VideoProcessingOptions as V, type FileRecord as W, type FileQueryOptions as X, type PaginatedResult as Y, type FileEvent as Z, type FileEventListener as _, type UploadProgress as a, FileServiceError as a0, FileUploadError as a1, FileProcessingError as a2, StorageProviderError as a3, CDNProviderError as a4, type FileQueryOptions$1 as b, UniversalFileService as c, type ProcessingOptions$1 as d, FileServiceError$1 as e, FileUploadError$1 as f, FileProcessingError$1 as g, type StorageType$1 as h, type CDNType$1 as i, type ProcessorType$1 as j, type UploadStatus as k, type AudioProcessingOptions as l, type UploadResult as m, type FileEventType$1 as n, type FileEvent$1 as o, type FileEventListener$1 as p, type UniversalFileServiceConfig as q, type StorageConfig as r, type IStorageProvider as s, type StorageType as t, type UploadFileInfo as u, type StorageResult as v, type ICDNProvider as w, type CDNType as x, type CDNConfig as y, type CDNResult as z };