@dofe/infra-clients 0.1.1

package/dist/internal/file-storage/file-qiniu.client.d.ts

@@ -0,0 +1,199 @@
+import { BatchOpsResult, DoFeUploader } from './dto/file.dto';
+import * as qiniu from 'qiniu';
+import { HttpService } from '@nestjs/axios';
+import { Logger } from 'winston';
+import { DoFeApp } from '@dofe/infra-common';
+import { StorageCredentialsConfig, AppConfig } from '@dofe/infra-common';
+import { FileStorageInterface } from './file-storage.interface';
+import { RedisService } from '@dofe/infra-redis';
+/**
+ * Qiniu File Storage Client
+ *
+ * 职责：仅负责与七牛云存储 API 通信
+ * - 不访问数据库
+ * - 不包含业务逻辑
+ */
+export declare class FileQiniuClient implements FileStorageInterface {
+    private mac;
+    private qiniuConfig;
+    private bucketManager;
+    private operManager;
+    private cdnManager;
+    private logger;
+    config: DoFeUploader.Config;
+    storageConfig: StorageCredentialsConfig;
+    appConfig: AppConfig;
+    redis: RedisService;
+    protected httpService: HttpService;
+    /**
+     * 构造函数，用于创建AppFile类的实例
+     *
+     */
+    constructor(config: DoFeUploader.Config, storageConfig: StorageCredentialsConfig, appConfig: AppConfig, redis: RedisService, httpService: HttpService, logger: Logger);
+    /**
+     * 上传凭证生成函数
+     *
+     * @param scope 空间名，可选参数，默认为配置中的 bucket
+     * @param options PutPolicyOptions 对象，可选参数，用于设置上传凭证的回调等选项，默认为配置中的 webhook 和 callbackBody 等信息
+     * @returns 返回生成的上传凭证字符串
+     */
+    uploadTokenWithCallback(callbackAuthKey?: string, scope?: string, options?: qiniu.rs.PutPolicyOptions, neeSpiltPart?: boolean): Promise<string>;
+    uploadToken(scope?: string, options?: qiniu.rs.PutPolicyOptions): Promise<string>;
+    setFileContentDisposition(fileKey: string, bucket?: string): Promise<void>;
+    /**
+     * 文件数据上传器
+     *
+     * @param fileData 文件数据流
+     * @param key 文件在七牛云上的存储键名
+     * @param bucket 文件存储的七牛云存储空间名称，默认为类内配置的存储空间
+     * @returns 返回上传成功的文件键名
+     * @throws 当上传失败时，抛出 ApiException 异常
+     */
+    fileDataUploader(base64Data: string, key: string, qbucket?: string): Promise<void>;
+    getPrivateDownloadUrl(fileKey: string, expire?: number, internal?: boolean, bucket?: string): Promise<string>;
+    /**
+     * 获取指定 bucket 的配置（辅助方法）
+     * 注意：七牛云服务通常一个实例对应一个 bucket，此方法用于兼容接口
+     */
+    private getBucketConfig;
+    /**
+     * 上传文件到七牛云
+     *
+     * @param filePath 文件的本地路径
+     * @param key 文件在七牛云上的存储键名
+     * @param bucket 文件存储的七牛云存储空间名称，默认为类内配置的存储空间
+     * @returns 返回上传成功的文件键名
+     * @throws 当上传失败时，抛出 ApiException 异常
+     */
+    uploadFile(filePath: string, key: string, bucket?: string): Promise<void>;
+    getFileInfo(fileKey: string, bucket?: string): Promise<any>;
+    changeFileMime(fileKey: string, newMime: string, bucket?: string): Promise<qiniu.httpc.ResponseWrapper<void>>;
+    changeFileHeaders(fileKey: string, headers: {
+        [key: string]: any;
+    }, bucket?: string): Promise<qiniu.httpc.ResponseWrapper<void>>;
+    changeType(fileKey: string, newType: number, bucket?: string): Promise<qiniu.httpc.ResponseWrapper<void>>;
+    moveFile(fileKey: string, bucket?: string, destBucket?: string, destKey?: string, options?: {
+        force?: boolean;
+    } | null): Promise<qiniu.httpc.ResponseWrapper<void>>;
+    copyFile(fileKey: string, bucket?: string, destBucket?: string, destKey?: string, options?: {
+        force?: boolean;
+    } | null): Promise<qiniu.httpc.ResponseWrapper<void>>;
+    deleteFile(fileKey: string, bucket?: string): Promise<boolean>;
+    /**
+     * 列出指定前缀的文件列表
+     *
+     * @param prefix 文件名前缀，默认为空字符串
+     * @param limit 最多返回的文件数量，默认为1000
+     * @param delimiter 用于限制目录层次的分隔符，默认为空字符串
+     * @param bucket 存储桶名称，默认为当前实例的存储桶
+     * @param options 其他可选参数
+     * @returns 返回一个Promise，解析后得到包含文件名的字符串数组
+     * @throws 当请求失败时，抛出ApiException异常
+     */
+    listFilesPrefix(prefix?: string, limit?: number, delimiter?: string, bucket?: string, options?: any): Promise<string[]>;
+    /**
+     * 从指定URL获取资源并存储到七牛云存储的指定Bucket中
+     *
+     * @param resUrl 资源URL
+     * @param fileKey 文件在Bucket中的键名
+     * @param bucket 存储Bucket的名称，默认为当前实例配置的Bucket
+     * @returns 返回一个Promise，解析为FetchObjectResult类型的七牛云HTTP响应包装对象
+     */
+    fetchToBucket(resUrl: string, fileKey: string, bucket?: string): Promise<any>;
+    /**
+     * 更新镜像副本
+     * @see https://developer.qiniu.com/kodo/api/1293/prefetch
+     *
+     * @param bucket 空间名称
+     * @param key 文件名称
+     */
+    prefetch(fileKey: string, bucket?: string): Promise<qiniu.httpc.ResponseWrapper<void>>;
+    /**
+     * 批量文件管理请求，支持stat，chgm，chtype，delete，copy，move
+     * @param operations
+     *
+     * --- 批量获取文件信息:qiniu.rs.statOp
+     * const statOperations = [
+     *      qiniu.rs.statOp(srcBucket, 'qiniu1.mp4'),
+     * ];
+     * --- 批量修改文件类型:qiniu.rs.changeMimeOp
+     * const chgmOperations = [
+     *      qiniu.rs.changeMimeOp(srcBucket, 'qiniu1.mp4', 'video/x-mp4'),
+     * ];
+     * --- 批量删除文件:qiniu.rs.deleteOp
+     * const deleteOperations = [
+     *      qiniu.rs.deleteOp(srcBucket, 'qiniu1.mp4'),
+     * ];
+     * --- 批量复制文件:qiniu.rs.copyOp
+     * const copyOperations = [
+     *      qiniu.rs.copyOp(srcBucket, srcKey, destBucket, 'qiniu1.mp4'),
+     * ];
+     * --- 批量移动或重命名文件:qiniu.rs.moveOp
+     * const moveOperations = [
+     *      qiniu.rs.moveOp(srcBucket, 'qiniu1.mp4', destBucket, 'qiniu1_move.mp4'),
+     * ];
+     * --- 批量更新文件的有效期: qiniu.rs.deleteAfterDaysOp
+     * const deleteAfterDaysOperations = [
+     *      qiniu.rs.deleteAfterDaysOp(srcBucket, 'qiniu1.mp4', 10),
+     * ];
+     * --- 批量更新文件存储类型: qiniu.rs.changeTypeOp
+     * newType：0 表示普通存储；1 表示低频存储；2 表示归档存储；3 表示深度归档存储；4 表示归档直读存储
+     * const changeTypeOperations = [
+     *      qiniu.rs.changeTypeOp(srcBucket, 'qiniu1.mp4', 1),
+     * ];
+     */
+    batch(operations: any): Promise<qiniu.httpc.ResponseWrapper<BatchOpsResult>>;
+    batchDeleteFiles(fileKeys: string[], bucket?: string): Promise<qiniu.httpc.ResponseWrapper<BatchOpsResult>>;
+    /**
+     * @returns 返回操作管理对象
+     * 发送持久化数据处理请求
+     * @param bucket 空间名称
+     * @param key 文件名称
+     * @param fops 处理指令集合
+     * @param pipeline 处理队列名称
+     * @param options
+     * @param callback
+     * @use pfop(bucket: string, key: string, fops: string[], pipeline: string, options: PfopOptions | null, callback: callback): void;
+     *
+     * 查询持久化数据处理进度
+     * @param persistentId pfop操作返回的持久化处理ID
+     * @param callback
+     *
+     * prefop(persistentId: string, callback: callback): void;
+     */
+    getOperManager(): qiniu.fop.OperationManager;
+    getCdnManager(): qiniu.cdn.CdnManager;
+    getConfig(): DoFeUploader.Config;
+    getPresignedUrl(bucket?: string, uploadId?: string, key?: string, partNumber?: number): Promise<string>;
+    getMultipartUploadId(fileKey: string, bucket?: string): Promise<string>;
+    getBucketString(bucket?: string): string;
+    getQiniuZone(): any;
+    listBuckets(): Promise<void>;
+    fileDownloader(source: DoFeApp.FileBase): Promise<Buffer>;
+    fileUploader(buffer: Buffer, destination: DoFeApp.FileBase): Promise<void>;
+    completeMultipartUpload(uploadId: string, key: string, parts: {
+        ETag: string;
+        PartNumber: number;
+    }[], bucket?: string): Promise<void>;
+    callbackValidate(requestURI: string, reqBody: string | null, callbackAuth: string): boolean;
+    makeZipWithKeys(files: Partial<FileSystem & any>[], zipName: string, bucket?: string): Promise<string>;
+    /**
+     * 执行pfop的fops操作
+     *
+     * @param key 文件对象在存储桶中的键（文件名）
+     * @param fops 操作的fops数组
+     * @param pipeline 使用的管道名称
+     * @param options 额外的请求选项
+     * @param bucket 指定的存储桶名称，默认为当前实例的存储桶
+     * @returns 返回Promise，解析为字符串类型的任务ID
+     * @throws 如果执行过程中出现错误，则抛出异常
+     */
+    pfopFops(key: string, fops: string, pipeline: string, options: any, bucket?: string): Promise<string>;
+    /**
+     * 查询Fop任务完成状态
+     * @param {string} persistentId
+     * @returns
+     */
+    queryFopStatus(persistentId: string): Promise<any>;
+}
+//# sourceMappingURL=file-qiniu.client.d.ts.map

package/dist/internal/file-storage/file-qiniu.client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-qiniu.client.d.ts","sourceRoot":"","sources":["../../../src/internal/file-storage/file-qiniu.client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,YAAY,EACb,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAKjC,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,wBAAwB,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGjD;;;;;;GAMG;AACH,qBAAa,eAAgB,YAAW,oBAAoB;IAC1D,OAAO,CAAC,GAAG,CAAwB;IACnC,OAAO,CAAC,WAAW,CAAoB;IACvC,OAAO,CAAC,aAAa,CAAyB;IAC9C,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,UAAU,CAAuB;IACzC,OAAO,CAAC,MAAM,CAAS;IAEvB,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC;IAC5B,aAAa,EAAE,wBAAwB,CAAC;IACxC,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,YAAY,CAAC;IACpB,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC;IAEnC;;;OAGG;gBAED,MAAM,EAAE,YAAY,CAAC,MAAM,EAC3B,aAAa,EAAE,wBAAwB,EACvC,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,YAAY,EACnB,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,MAAM;IA2BhB;;;;;;OAMG;IACG,uBAAuB,CAC3B,eAAe,CAAC,EAAE,MAAM,EACxB,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,gBAAgB,EACnC,YAAY,CAAC,EAAE,OAAO,GACrB,OAAO,CAAC,MAAM,CAAC;IA2BZ,WAAW,CACf,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,gBAAgB,GAClC,OAAO,CAAC,MAAM,CAAC;IASZ,yBAAyB,CAC7B,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC;IAEhB;;;;;;;;OAQG;IACG,gBAAgB,CACpB,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC;IAqBV,qBAAqB,CACzB,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,OAAO,EAClB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC;IAuBlB;;;OAGG;YACW,eAAe;IAa7B;;;;;;;;OAQG;IACG,UAAU,CACd,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,EACX,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC;IA2BV,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAK3D,cAAc,CAClB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAKvC,iBAAiB,CACrB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAC/B,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAcvC,UAAU,CACd,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAKvC,QAAQ,CACZ,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,GACnC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAYvC,QAAQ,CACZ,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,GACnC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAYvC,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAcpE;;;;;;;;;;OAUG;IACG,eAAe,CACnB,MAAM,CAAC,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,GAAG,GACZ,OAAO,CAAC,MAAM,EAAE,CAAC;IAqBpB;;;;;;;OAOG;IACG,aAAa,CACjB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,GAAG,CAAC;IAcf;;;;;;OAMG;IACG,QAAQ,CACZ,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAK7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,KAAK,CACT,UAAU,EAAE,GAAG,GACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;IAIjD,gBAAgB,CACpB,QAAQ,EAAE,MAAM,EAAE,EAClB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;IASvD;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc;IAId,aAAa;IAIb,SAAS,IAAI,YAAY,CAAC,MAAM;IAI1B,eAAe,CACnB,MAAM,CAAC,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,MAAM,EACjB,GAAG,CAAC,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC;IAIZ,oBAAoB,CACxB,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC;IA6BlB,eAAe,CAAC,MAAM,CAAC,EAAE,MAAM;IAM/B,YAAY,IAAI,GAAG;IAWb,WAAW;IAEX,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;IAIzD,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,QAAQ;IAE1D,uBAAuB,CAC3B,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,EAAE,EAC7C,MAAM,CAAC,EAAE,MAAM;IAGjB,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,YAAY,EAAE,MAAM,GACnB,OAAO;IASJ,eAAe,CACnB,KAAK,EAAE,OAAO,CAAC,UAAU,GAAG,GAAG,CAAC,EAAE,EAClC,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC;IA4DlB;;;;;;;;;;OAUG;IACG,QAAQ,CACZ,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,GAAG,EACZ,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC;IA0BlB;;;;OAIG;IACG,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAoBzD"}