doomistorage 1.0.0

package/dist/cosfile.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="node" />
+import { FileConfig, FileResult } from "./declare";
+import { FileBase } from "./file";
+export declare class CosFile extends FileBase {
+    private bucket;
+    private cos;
+    private region;
+    constructor(config: any);
+    /**
+     *
+     * @param data
+     * @param fileName
+     * @param saveOption
+     * @param userInfo
+     */
+    saveString2File(data: string | Buffer, fileName: string, saveOption: FileConfig, userInfo?: any): Promise<FileResult>;
+    /**
+     *
+     * @param file
+     * @param fileName
+     * @param saveOption
+     * @param userInfo
+     * @returns
+     */
+    saveFileStream(file: any, fileName: any, saveOption: any, userInfo: any): Promise<FileResult>;
+}

package/dist/cosfile.js

@@ -0,0 +1,102 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CosFile = void 0;
+const file_1 = require("./file");
+const cos_nodejs_sdk_v5_1 = __importDefault(require("cos-nodejs-sdk-v5"));
+class CosFile extends file_1.FileBase {
+    constructor(config) {
+        super();
+        this.cos = new cos_nodejs_sdk_v5_1.default({
+            SecretId: config.SecretId,
+            SecretKey: config.SecretKey
+        });
+        this.bucket = config.bucket;
+        this.region = config.region;
+    }
+    /**
+     *
+     * @param data
+     * @param fileName
+     * @param saveOption
+     * @param userInfo
+     */
+    saveString2File(data, fileName, saveOption, userInfo = {}) {
+        if (!data)
+            data = '';
+        let destinationFileName = this.getSaveFileName(saveOption, fileName, userInfo);
+        const streamBuffer = data instanceof Buffer ? data : Buffer.from(data, "utf-8");
+        const fileParam = {
+            Bucket: this.bucket,
+            Region: this.region,
+            Key: destinationFileName,
+            Body: streamBuffer,
+            ContentLength: streamBuffer.byteLength
+        };
+        return new Promise((success) => {
+            this.cos.putObject(fileParam, (err) => {
+                return success({ successed: err == null, filePath: destinationFileName });
+            });
+        });
+    }
+    /**
+     *
+     * @param file
+     * @param fileName
+     * @param saveOption
+     * @param userInfo
+     * @returns
+     */
+    saveFileStream(file, fileName, saveOption, userInfo) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const destinationFileName = this.getSaveFileName(saveOption, fileName, userInfo);
+            return new Promise((resolve) => {
+                if (saveOption.reRead) {
+                    let dataArr = [], //存储读取的结果集合  
+                    len = 0;
+                    file.on('data', (chunk) => {
+                        dataArr.push(chunk);
+                        len += chunk.length;
+                    });
+                    file.on('end', () => {
+                        const fileParam = {
+                            Bucket: this.bucket,
+                            Region: this.region,
+                            Key: destinationFileName,
+                            Body: Buffer.concat(dataArr, len),
+                            ContentLength: len // file.byteCount ||  saveOption.contentLength 
+                        };
+                        this.cos.putObject(fileParam, (err) => {
+                            return resolve({ successed: err == null, filePath: destinationFileName });
+                        });
+                    });
+                }
+                else {
+                    const fileParam = {
+                        Bucket: this.bucket,
+                        Region: this.region,
+                        // ContentDisposition: "form-data; name=\"file\"; filename=\"" + encodeURIComponent(destinationFileName) + "\"",
+                        Key: destinationFileName,
+                        Body: file,
+                        ContentLength: file.byteCount || file.length
+                    };
+                    this.cos.putObject(fileParam, function (err) {
+                        return resolve({ successed: err == null, filePath: destinationFileName });
+                    });
+                }
+            });
+        });
+    }
+}
+exports.CosFile = CosFile;

package/dist/declare.d.ts

@@ -0,0 +1,16 @@
+export interface FileConfig {
+    'subFolder': string;
+    'saveDir': string;
+    'fileName': string;
+    'reRead'?: boolean;
+    'basefolder'?: string;
+}
+/**
+ * 文件的API
+ */
+export interface FileResult {
+    'successed': boolean;
+    'error'?: string;
+    'errcode'?: number;
+    'filePath'?: string;
+}

package/dist/declare.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/file.d.ts

@@ -0,0 +1,47 @@
+/// <reference types="node" />
+import { FileConfig, FileResult } from './declare';
+export declare abstract class FileBase {
+    /**
+     * 根据DoomiSoft框架生成的唯一文件名，用户上传后的文件存储后名称，防止重复
+     * @param {*} saveOption
+     * @param {*} fileName
+     * @param {*} userInfo
+     */
+    getSaveFileName(saveOption: FileConfig, fileName: string, userInfo?: any): string;
+    /**
+     * 获取文件需要保存的目录
+     * @param {*} saveOption
+     * @param {*} userInfo
+     */
+    getSaveFolder(saveOption: FileConfig, userInfo?: any): string;
+    /**
+     * 获取上传的文件仅包含文件名
+     * @param {*} saveOption
+     * @param {*} fileName
+     * @param {*} userInfo
+     */
+    getSaveOnlyFileName(saveOption: FileConfig, fileName: string, userInfo?: any): string;
+    /**
+     * 保存文件流
+     * @param fileName
+     * @param file
+     * @param saveOption
+     * @param userInfo
+     */
+    abstract saveFileStream(file: any, fileName: string, saveOption: FileConfig, userInfo: any): Promise<FileResult>;
+    /**
+     * 直接保存字符
+     * @param data
+     * @param fileName
+     * @param saveOption
+     * @param userInfo
+     */
+    abstract saveString2File(data: string | Buffer, fileName: string, saveOption: FileConfig, userInfo: any): Promise<FileResult>;
+    /**
+     * 创建多级目录
+     * @param dirpath
+     * @param mode
+     * @returns
+     */
+    mkdirsSync(dirpath: string, mode?: any): boolean;
+}

package/dist/file.js

@@ -0,0 +1,116 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileBase = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const moment_1 = __importDefault(require("moment"));
+const node_uuid_1 = require("node-uuid");
+class FileBase {
+    /**
+     * 根据DoomiSoft框架生成的唯一文件名，用户上传后的文件存储后名称，防止重复
+     * @param {*} saveOption
+     * @param {*} fileName
+     * @param {*} userInfo
+     */
+    getSaveFileName(saveOption, fileName, userInfo = {}) {
+        let saveFolder = this.getSaveFolder(saveOption, userInfo);
+        console.log('getSaveFileName', fileName);
+        let _fileName = this.getSaveOnlyFileName(saveOption, fileName, userInfo);
+        return path_1.default.join(saveFolder, _fileName);
+    }
+    /**
+     * 获取文件需要保存的目录
+     * @param {*} saveOption
+     * @param {*} userInfo
+     */
+    getSaveFolder(saveOption, userInfo = {}) {
+        var _a;
+        let subFolder = '';
+        ///分目录存储
+        switch ((saveOption.subFolder || '').toLowerCase()) {
+            ///按日建造一个目录
+            case 'onebydate':
+                subFolder = (0, moment_1.default)().format('YYYYMMDD');
+                break;
+            ///按日建造多级目录
+            case 'mutilbydate':
+                subFolder = (0, moment_1.default)().year() + path_1.default.sep + (0, moment_1.default)().month() + path_1.default.sep + (0, moment_1.default)().day();
+                break;
+            ///用自己的id(当前登录的id)建造目录
+            case 'identity':
+                subFolder = (_a = userInfo.id) !== null && _a !== void 0 ? _a : (0, node_uuid_1.v4)();
+                break;
+        }
+        let saveFolder = path_1.default.join(saveOption.saveDir, subFolder + '');
+        if (userInfo && userInfo.subfolder)
+            saveFolder = path_1.default.join(saveFolder, userInfo.subfolder);
+        ///如果包含当前调用用户的信息，则替换整个路径中的@@关键字
+        if (userInfo) {
+            const matched = saveFolder.match(/@.*?@/g);
+            if (matched && matched.length > 0)
+                matched.forEach(ele => {
+                    const matchValue = ele.substring(1, ele.length - 1);
+                    if (matchValue.indexOf(' ') >= 0 || matchValue.indexOf(':') >= 0 || matchValue.indexOf('=') >= 0)
+                        return;
+                    let keyName = ele.substring(1, ele.length - 1);
+                    const keyValue = userInfo[keyName] || '';
+                    saveFolder = saveFolder.replace(ele, keyValue);
+                });
+        }
+        return saveFolder;
+    }
+    /**
+     * 获取上传的文件仅包含文件名
+     * @param {*} saveOption
+     * @param {*} fileName
+     * @param {*} userInfo
+     */
+    getSaveOnlyFileName(saveOption, fileName, userInfo = {}) {
+        var _a;
+        let _fileName = '';
+        switch ((saveOption.fileName || 'keep').toLowerCase()) {
+            ///保持和原有文件一致的文件名
+            case "keep":
+                _fileName = fileName;
+                break;
+            ///随机命名,但后缀必须一致
+            case "random":
+                _fileName = (0, node_uuid_1.v4)() + path_1.default.extname(fileName);
+                break;
+            ///使用当前账号的id命名
+            case "identity":
+                _fileName = ((_a = userInfo.id) !== null && _a !== void 0 ? _a : (0, node_uuid_1.v4)()) + path_1.default.extname(fileName);
+                break;
+        }
+        return _fileName;
+    }
+    /**
+     * 创建多级目录
+     * @param dirpath
+     * @param mode
+     * @returns
+     */
+    mkdirsSync(dirpath, mode = null) {
+        if (!fs_1.default.existsSync(dirpath)) {
+            let pathtmp = '', splitPath = dirpath.split(path_1.default.sep);
+            for (const dirname of splitPath) {
+                if (dirname.length == 0) {
+                    pathtmp = path_1.default.sep;
+                    continue;
+                }
+                if (pathtmp)
+                    pathtmp = path_1.default.join(pathtmp, dirname);
+                else
+                    pathtmp = dirname;
+                if (!fs_1.default.existsSync(pathtmp)) {
+                    fs_1.default.mkdirSync(pathtmp, mode);
+                }
+            }
+        }
+        return true;
+    }
+}
+exports.FileBase = FileBase;

package/dist/filehelper.d.ts

@@ -0,0 +1,74 @@
+import { FileConfig, FileResult } from "./declare";
+import { FileBase } from "./file";
+/**
+ * 文件处理器类型
+ */
+export declare const FileProviderEnum: {
+    readonly LOCAL: "local";
+    readonly TENCENTCOS: "tencentcos";
+};
+export type FileProviderEnum = typeof FileProviderEnum[keyof typeof FileProviderEnum];
+/**
+ * 获取到文件处理的对象
+ * @param destination
+ * @returns
+ */
+export declare function FileHelper(provider: FileProviderEnum, apiOption?: any): FileUtility;
+/**
+ * 文件帮助工具
+ */
+declare class FileUtility {
+    private fileHandler;
+    constructor(handler: FileBase);
+    /**
+     * 读取文件并保存至目标路径
+     * @param file 文件对象
+     * @param provider : 文件处理的实例名
+     * @param fileName :最终需要保存的文件名称
+     * @param saveOption :
+     * @param userInfo
+     * @returns
+     */
+    SaveFileStream(fileName: string, file: any, saveOption: FileConfig, userInfo?: any): Promise<FileResult>;
+    /**
+     * 保存字符流到对应的存储设备
+     * @param bufferData
+     * @param fileName
+     * @param saveOption
+     * @param userInfo
+     * @returns
+     */
+    SaveString2File(bufferData: any, fileName: string, saveOption: FileConfig, userInfo?: any): Promise<FileResult>;
+    /**
+     * 下载文件并且保存
+     * @param saveDestination
+     * @param fileUrl
+     * @param savesetting
+     * @param userinfo
+     * @param allowWebPFormat
+     * @returns
+     */
+    DownloadFile(fileUrl: string, savefileName: string, savesetting: FileConfig, userInfo?: any, allowWebPFormat?: boolean): Promise<FileResult>;
+    /**
+     * 预测生成文件保存后的文件路径
+     * @param saveOption
+     * @param fileName
+     * @param userInfo
+     */
+    getSaveFileName(saveOption: FileConfig, fileName: string, userInfo?: any): string;
+    /**
+    * 预测生成文件保存后的文件路径
+    * @param saveOption
+    * @param fileName
+    * @param userInfo
+    */
+    getSaveFolder(saveOption: FileConfig, userInfo?: any): string;
+    /**
+    * 预测生成文件保存后的文件名称
+    * @param saveOption
+    * @param fileName
+    * @param userInfo
+    */
+    getSaveOnlyFileName(saveOption: FileConfig, fileName: string, userInfo?: any): string;
+}
+export {};

package/dist/filehelper.js

@@ -0,0 +1,133 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileHelper = exports.FileProviderEnum = void 0;
+const cosfile_1 = require("./cosfile");
+const localfile_1 = require("./localfile");
+const axios_1 = __importDefault(require("axios"));
+const path_1 = __importDefault(require("path"));
+/**
+ * 文件处理器类型
+ */
+exports.FileProviderEnum = {
+    LOCAL: 'local',
+    TENCENTCOS: 'tencentcos',
+};
+/**
+ * 获取到文件处理的对象
+ * @param destination
+ * @returns
+ */
+function FileHelper(provider, apiOption) {
+    let filehandler;
+    switch (provider) {
+        case exports.FileProviderEnum.LOCAL:
+            filehandler = new localfile_1.LocalFile();
+            break;
+        case exports.FileProviderEnum.TENCENTCOS:
+            filehandler = new cosfile_1.CosFile(apiOption);
+            break;
+        default: filehandler = new localfile_1.LocalFile();
+    }
+    return new FileUtility(filehandler);
+}
+exports.FileHelper = FileHelper;
+/**
+ * 文件帮助工具
+ */
+class FileUtility {
+    constructor(handler) {
+        this.fileHandler = handler;
+    }
+    /**
+     * 读取文件并保存至目标路径
+     * @param file 文件对象
+     * @param provider : 文件处理的实例名
+     * @param fileName :最终需要保存的文件名称
+     * @param saveOption :
+     * @param userInfo
+     * @returns
+     */
+    SaveFileStream(fileName, file, saveOption, userInfo = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.fileHandler.saveFileStream(file, fileName, saveOption, userInfo);
+        });
+    }
+    /**
+     * 保存字符流到对应的存储设备
+     * @param bufferData
+     * @param fileName
+     * @param saveOption
+     * @param userInfo
+     * @returns
+     */
+    SaveString2File(bufferData, fileName, saveOption, userInfo = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.fileHandler.saveString2File(bufferData, fileName, saveOption, userInfo);
+        });
+    }
+    /**
+     * 下载文件并且保存
+     * @param saveDestination
+     * @param fileUrl
+     * @param savesetting
+     * @param userinfo
+     * @param allowWebPFormat
+     * @returns
+     */
+    DownloadFile(fileUrl, savefileName, savesetting, userInfo = {}, allowWebPFormat = false) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!allowWebPFormat && fileUrl.indexOf('&tp=webp') >= 0)
+                fileUrl = fileUrl.replace('&tp=webp', '');
+            let fileName = savefileName ? savefileName : path_1.default.basename(fileUrl);
+            try {
+                const downloadResult = yield axios_1.default.get(fileUrl, { responseType: 'arraybuffer' });
+                if (downloadResult.data) {
+                    return this.SaveString2File(downloadResult.data, fileName, savesetting, userInfo);
+                }
+                return { successed: false, error: '下载文件中没有任何内容' };
+            }
+            catch (error) {
+                return { successed: false, error: error };
+            }
+        });
+    }
+    /**
+     * 预测生成文件保存后的文件路径
+     * @param saveOption
+     * @param fileName
+     * @param userInfo
+     */
+    getSaveFileName(saveOption, fileName, userInfo = {}) {
+        return this.fileHandler.getSaveFileName(saveOption, fileName, userInfo);
+    }
+    /**
+    * 预测生成文件保存后的文件路径
+    * @param saveOption
+    * @param fileName
+    * @param userInfo
+    */
+    getSaveFolder(saveOption, userInfo = {}) {
+        return this.fileHandler.getSaveFolder(saveOption, userInfo);
+    }
+    /**
+    * 预测生成文件保存后的文件名称
+    * @param saveOption
+    * @param fileName
+    * @param userInfo
+    */
+    getSaveOnlyFileName(saveOption, fileName, userInfo = {}) {
+        return this.fileHandler.getSaveOnlyFileName(saveOption, fileName, userInfo);
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './filehelper';
+export * from './uploader';

package/dist/index.js

@@ -0,0 +1,18 @@
+"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 });
+__exportStar(require("./filehelper"), exports);
+__exportStar(require("./uploader"), exports);

package/dist/localfile.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="node" />
+import { FileBase } from "./file";
+import { FileConfig, FileResult } from "./declare";
+export declare class LocalFile extends FileBase {
+    /**
+     * 直接保存字符串
+     * @param data
+     * @param fileName
+     * @param saveOption
+     * @param userInfo
+     */
+    saveString2File(data: string | Buffer, fileName: string, saveOption: FileConfig, userInfo?: any): Promise<FileResult>;
+    /**
+     * 读取文件对象并保存至本地存储
+     * @param file
+     * @param fileName
+     * @param saveOption
+     * @param userInfo
+     * @returns
+     */
+    saveFileStream(file: any, fileName: any, saveOption: FileConfig, userInfo: any): Promise<FileResult>;
+}

package/dist/localfile.js

@@ -0,0 +1,67 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalFile = void 0;
+const file_1 = require("./file");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+class LocalFile extends file_1.FileBase {
+    /**
+     * 直接保存字符串
+     * @param data
+     * @param fileName
+     * @param saveOption
+     * @param userInfo
+     */
+    saveString2File(data, fileName, saveOption, userInfo = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let baseFileName = this.getSaveFileName(saveOption, fileName, userInfo);
+            if (!baseFileName)
+                return { successed: false };
+            let fullFileName = path_1.default.resolve(saveOption.basefolder || '', baseFileName);
+            let _saveDir = path_1.default.dirname(fullFileName);
+            ///创建本地文件夹
+            if (!this.mkdirsSync(_saveDir))
+                return { successed: false };
+            return new Promise(resolve => {
+                fs_1.default.writeFile(fullFileName, data, (error) => {
+                    return resolve({ successed: error == null, filePath: fullFileName });
+                });
+            });
+        });
+    }
+    /**
+     * 读取文件对象并保存至本地存储
+     * @param file
+     * @param fileName
+     * @param saveOption
+     * @param userInfo
+     * @returns
+     */
+    saveFileStream(file, fileName, saveOption, userInfo) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let baseFileName = this.getSaveFileName(saveOption, fileName, userInfo);
+            if (!baseFileName)
+                return { successed: false };
+            let fullFileName = path_1.default.resolve(saveOption.basefolder || '', baseFileName);
+            let _saveDir = path_1.default.dirname(fullFileName);
+            ///创建本地文件夹
+            if (!this.mkdirsSync(_saveDir))
+                return { successed: false };
+            file.pipe(fs_1.default.createWriteStream(fullFileName));
+            return { successed: true, filePath: fullFileName };
+        });
+    }
+}
+exports.LocalFile = LocalFile;

package/dist/uploader.d.ts

@@ -0,0 +1,2 @@
+import multer from 'multer';
+export declare function getFileUploader(uploadConfig: any): multer.Multer;