doomistorage 2.0.0 → 2.0.1

package/.claude/settings.local.json

@@ -0,0 +1,7 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(git *)"
+    ]
+  }
+}

package/CLAUDE.md

@@ -0,0 +1,53 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Build & Test
+
+```bash
+# Build (rollup — outputs CJS + ESM to dist/)
+npm run build
+
+# Build with tsc only (CJS, stricter checks)
+npm run build:tsc
+```
+
+There is no test suite wired up (`jest` is in devDependencies but no `test` script exists in package.json). Manual verification scripts live in `test/` and import from `dist/`, so build first before running them.
+
+## Architecture
+
+This package (`doomistorage`) is part of the `doomisuite` monorepo within `doomiframework`. It provides a unified file-storage abstraction over three backends.
+
+**Strategy pattern with factory:**
+
+```
+FileBase (abstract)
+ ├── LocalFile      — local disk via fs
+ ├── CosFile        — Tencent Cloud Object Storage (COS)
+ └── AzureBlob      — Azure Blob Storage
+
+FileHelper(provider?, config?) → FileUtility   // factory function
+FileUtility                                  // public API facade wrapping any backend
+```
+
+- `FileBase` (`src/file.ts`) — abstract class defining the contract: `saveFileStream`, `saveString2File`, `deleteFile`, `getTemporaryToken`. Also contains shared logic for generating save paths and filenames based on `FileConfig` (date-based subfolders, random/identity-based naming, `@@variable@@` interpolation from `userInfo`).
+- `FileHelper()` (`src/filehelper.ts`) — factory that reads a `configuration.json` from `process.cwd()` (or `CONFIGFILE` env var) to resolve provider config, instantiates the correct `FileBase` subclass, and wraps it in a `FileUtility`.
+- `FileUtility` — adds cross-cutting features on top of any backend: `BatchDownloadImage`, `DownloadFile` (HTTP download then save), and passthrough delegation for all `FileBase` methods.
+
+**FileConfig** (`src/declare.ts`) controls where and how files are saved:
+
+| Field | Purpose |
+|---|---|
+| `subFolder` | `onebydate` / `mutilbydate` / `identity` — auto-generated directory structure |
+| `saveDir` | base directory within the storage bucket/container |
+| `fileName` | `keep` / `random` / `identity` — naming strategy |
+| `reRead` | (CosFile only) buffer stream chunks before upload |
+| `basefolder` | (LocalFile only) root path on disk |
+
+**Uploader** (`src/uploader.ts`) — separate from the strategy hierarchy. Provides `getFileUploader(config)` which returns a multer instance configured with `LocalFile` path logic for Express-based local upload handling.
+
+**Exports** (`src/index.ts`) — re-exports everything from `filehelper` and `uploader`.
+
+**Build:** Rollup takes `src/index.ts` as entry, runs it through the TypeScript plugin, and produces two outputs: CJS (`dist/index.js`) and ESM (`dist/index.esm.js`). Dependencies and peerDependencies are externals. An alternative `build:tsc` script compiles with stricter TS flags (`noUnusedLocals`, `noUnusedParameters`, etc.) and outputs CJS only.
+
+**Peer dependencies:** `axios` (used by `FileUtility.DownloadFile`) and `moment` (used by `FileBase` for date-based folder naming). Consumers must provide these.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doomistorage",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "",
   "main": "./dist/index.js",
   "module": "./dist/index.esm.js",
@@ -20,7 +20,6 @@
     "@types/jest": "^27.5.2",
     "@types/multer": "^1.4.7",
     "@types/node": "^18.15.3",
-    "@types/node-uuid": "^0.0.29",
     "jest": "^27.3.1",
     "jest-html-reporters": "^2.1.6",
     "rollup": "^2.79.2",
@@ -32,12 +31,16 @@
   "dependencies": {
     "@azure/storage-blob": "^12.29.1",
     "cos-nodejs-sdk-v5": "^2.16.0-beta.8",
-    "moment": "^2.29.4",
     "multer": "^1.4.5-lts.1",
-    "tencentcloud-sdk-nodejs-sts": "^4.1.100",
-    "uuid": "^11.1.0"
+    "tencentcloud-sdk-nodejs-sts": "^4.1.100"
   },
   "peerDependencies": {
-    "axios": "*"
+    "axios": "*",
+    "moment": "*"
+  },
+  "overrides": {
+    "tencentcloud-sdk-nodejs-sts":{
+      "uuid":"11.1.1"
+    }
   }
-}
+}

package/src/azureblob.ts

@@ -32,7 +32,7 @@ export class AzureBlob extends FileBase {
         const containerSAS = generateBlobSASQueryParameters(
             {
                 containerName: this.config.container, // Required
-                permissions: ContainerSASPermissions.parse("rw"), // Required
+                permissions: ContainerSASPermissions.parse(permission), // Required
                 startsOn: new Date(), // Optional   从当前开始计算
                 expiresOn: new Date(new Date().valueOf() + expiresSeconds * 1000), // Required. Date type   
                 // ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
@@ -77,7 +77,7 @@ export class AzureBlob extends FileBase {
      */
     async deleteFile(filepath: string | string[]): Promise<{ successed: boolean,error?:any }> {
         if (!Array.isArray(filepath)) filepath = [filepath];
-        for(const file of filepath) this.containerClient.deleteBlob(file)
+        for (const file of filepath) await this.containerClient.deleteBlob(file)
         return { successed: true }
     }
 }

package/src/cosfile.ts

@@ -53,7 +53,7 @@ export class CosFile extends FileBase {
      */
     saveString2File(data: string | Buffer, fileName: string, saveOption: FileConfig, userInfo: any = {}): Promise<FileResult> {
         if (!data) data = '';
-        let destinationFileName = this.getSaveFileName(saveOption, fileName, userInfo);
+        const destinationFileName = this.getSaveFileName(saveOption, fileName, userInfo);
         const streamBuffer = data instanceof Buffer ? data : Buffer.from(data, "utf-8");
         const fileParam = {
             Bucket: this.bucket,
@@ -62,9 +62,9 @@ export class CosFile extends FileBase {
             Body: streamBuffer,
             ContentLength: streamBuffer.byteLength
         };
-        return new Promise((success) => {
-            this.cos.putObject(fileParam, (err: any) => {
-                return success({ successed: err == null, filePath: destinationFileName });
+        return new Promise((resolve) => {
+            this.cos.putObject(fileParam, (error: any) => {
+                return resolve({ successed: !error, filePath: destinationFileName,error });
             });
         });
     }
@@ -86,6 +86,9 @@ export class CosFile extends FileBase {
                     dataArr.push(chunk);
                     len += chunk.length;
                 });
+                file.on('error', (error: any) => {
+                    return resolve({ successed: false, error })
+                });
                 file.on('end', () => {
                     const fileParam = {
                         Bucket: this.bucket,
@@ -94,8 +97,8 @@ export class CosFile extends FileBase {
                         Body: Buffer.concat(dataArr, len), //file,
                         ContentLength: len// file.byteCount ||  saveOption.contentLength 
                     };
-                    this.cos.putObject(fileParam, (err) => {
-                        return resolve({ successed: err == null, filePath: destinationFileName })
+                    this.cos.putObject(fileParam, (error:any) => {
+                        return resolve({ successed: !error, filePath: destinationFileName, error })
 
                     })
                 });
@@ -109,8 +112,8 @@ export class CosFile extends FileBase {
                     ContentLength: file.byteCount || file.length
                 };
 
-                this.cos.putObject(fileParam, function (err) {
-                    return resolve({ successed: err == null, filePath: destinationFileName })
+                this.cos.putObject(fileParam, (error:any)=> {
+                    return resolve({ successed: !error, filePath: destinationFileName, error })
                 })
             }
         });
@@ -120,7 +123,7 @@ export class CosFile extends FileBase {
      * @param filepath 
      */
     async deleteFile(filepath: string | string[]): Promise<{ successed: boolean,error?:any }> {
-        return new Promise(reslove => {
+        return new Promise((resolve) => {
             ///如果是数组，则一次性删除多个文件
             if (Array.isArray(filepath)) {
                 const params = {
@@ -129,7 +132,7 @@ export class CosFile extends FileBase {
                     Objects: filepath.map(item => { return { Key: item } }),
                 };
                 return this.cos.deleteMultipleObject(params, (err: any) => {
-                    return reslove({ successed: err == null, error: err })
+                    return resolve({ successed: err == null, error: err })
                 })
             }
             const params = {
@@ -138,7 +141,7 @@ export class CosFile extends FileBase {
                 Key: filepath,
             };
             this.cos.deleteObject(params, (err: any) => {
-                return reslove({ successed: err == null, error: err })
+                return resolve({ successed: err == null, error: err })
             })
         })
 

package/src/declare.ts

@@ -1,7 +1,9 @@
+type SubFolderType = 'onebydate' | 'mutilbydate' | 'identity'
+type FileNameingType = 'keep' | 'random' | 'identity'
 export interface FileConfig{
-    'subFolder':string,
+    'subFolder': SubFolderType,
     'saveDir':string,
-    'fileName':string,
+    'fileName': FileNameingType,
     'reRead'?:boolean,
     'basefolder'?:string    ////根路径，主要对local使用
 }
@@ -10,7 +12,7 @@ export interface FileConfig{
  */
 export interface FileResult {
     'successed': boolean;
-    'error'?: string;
+    'error'?: string|object;
     'errcode'?: number;
     'filePath'?:string
 }

package/src/file.ts

@@ -1,7 +1,7 @@
 import fs from 'fs';
 import path from 'path';
 import Moment from 'moment';
-import { v4 as UUIDV4 } from 'uuid'
+import { randomUUID as UUIDV4 } from 'crypto'
 import { FileConfig, FileResult } from './declare';
 export abstract class FileBase {
     /**
@@ -11,9 +11,9 @@ export abstract class FileBase {
      * @param {*} userInfo 
      */
     getSaveFileName(saveOption: FileConfig, fileName: string, userInfo: any = {}): string {
-        let saveFolder = this.getSaveFolder(saveOption, userInfo)
+        const saveFolder = this.getSaveFolder(saveOption, userInfo)
         // console.log('getSaveFileName', fileName)
-        let _fileName = this.getSaveOnlyFileName(saveOption, fileName, userInfo);
+        const _fileName = this.getSaveOnlyFileName(saveOption, fileName, userInfo);
         return path.join(saveFolder, _fileName);
     }
     /**
@@ -28,7 +28,7 @@ export abstract class FileBase {
             ///按日建造一个目录
             case 'onebydate': subFolder = Moment().format('YYYYMMDD'); break;
             ///按日建造多级目录
-            case 'mutilbydate': subFolder = Moment().year() + path.sep + Moment().month() + path.sep + Moment().day(); break;
+            case 'mutilbydate': subFolder = path.join(String(Moment().year()), String(Moment().month()+1), String(Moment().date())); break;
             ///用自己的id(当前登录的id)建造目录
             case 'identity': subFolder = userInfo.id ?? UUIDV4(); break;
         }
@@ -39,10 +39,9 @@ export abstract class FileBase {
             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] || ''
+                    const matchKey = ele.substring(1, ele.length - 1);
+                    if (matchKey.indexOf(' ') >= 0 || matchKey.indexOf(':') >= 0 || matchKey.indexOf('=') >= 0) return;
+                    const keyValue = userInfo[matchKey] || ''
                     saveFolder = saveFolder.replace(ele, keyValue);
                 });
         }
@@ -55,16 +54,15 @@ export abstract class FileBase {
      * @param {*} userInfo 
      */
     getSaveOnlyFileName(saveOption: FileConfig, fileName: string, userInfo: any = {}): string {
-        let _fileName = '';
         switch ((saveOption.fileName || 'keep').toLowerCase()) {
             ///保持和原有文件一致的文件名
-            case "keep": _fileName = fileName; break;
+            case "keep": return fileName; 
             ///随机命名,但后缀必须一致
-            case "random": _fileName = UUIDV4() + path.extname(fileName); break;
+            case "random": return UUIDV4() + path.extname(fileName); 
             ///使用当前账号的id命名
-            case "identity": _fileName = (userInfo.id ?? UUIDV4()) + path.extname(fileName); break;
+            case "identity": return (userInfo.id ?? UUIDV4()) + path.extname(fileName);
         }
-        return _fileName;
+        return fileName;
     }
     /**
      * 保存文件流
@@ -99,22 +97,13 @@ export abstract class FileBase {
      * @returns 
      */
     mkdirsSync(dirpath: string, mode: any = null): boolean {
-        if (!fs.existsSync(dirpath)) {
-            let pathtmp = '', splitPath = dirpath.split(path.sep);
-            for (const dirname of splitPath) {
-                if (dirname.length == 0) {
-                    pathtmp = path.sep;
-                    continue;
-                }
-                if (pathtmp)
-                    pathtmp = path.join(pathtmp, dirname);
-                else
-                    pathtmp = dirname;
-                if (!fs.existsSync(pathtmp)) {
-                    fs.mkdirSync(pathtmp, mode)
-                }
-            }
+        try {
+            const options: any = { recursive: true };
+            if (mode !== null) options.mode = mode;
+            fs.mkdirSync(dirpath, options);
+            return true;
+        } catch {
+            return false;
         }
-        return true;
     }
 }

package/src/filehelper.ts

@@ -13,13 +13,12 @@ let config:any;
  */
 function getConfigurationSetting(settingName?:string,isSection:boolean=true):any{
     if (!config){
-        let configfilename = process.env["CONFIGFILE"] || 'configuration.json'
-        let configfile = path.join(process.cwd(), configfilename);
+        const configfilename = process.env["CONFIGFILE"] || 'configuration.json'
+        const configfile = path.join(process.cwd(), configfilename);
         if (!fs.existsSync(configfile)) return null;
         config = require(configfile);
     }
     if (!config) return null;
-    //const config = require(configfile)[settingName || 'tencentCOS'];
     return isSection ? config[settingName || 'tencentCOS'] : (config.appsetting[settingName ||'destination']??'tencentcos') ;
 }
 /**
@@ -62,7 +61,7 @@ export function FileHelper(provider?: FileProviderEnum, apiOption?: any): FileUt
 /**
  * 文件帮助工具
  */
-class FileUtility {
+export class FileUtility {
     private fileHandler: FileBase;
     constructor(handler: FileBase) {
         this.fileHandler = handler;
@@ -124,7 +123,7 @@ class FileUtility {
      * @returns 
      */
     async BatchDownloadImage(urlArray: string[], saveOption: FileConfig, userInfo: any = {}): Promise<FileResult[]> {
-        let promiseArr = [];
+        const promiseArr = [];
         for (const url of urlArray) {
             promiseArr.push(this.DownloadFile(url, null, saveOption, userInfo))
         }
@@ -141,7 +140,7 @@ class FileUtility {
      */
     async DownloadFile(fileUrl: string, savefileName: string | null, savesetting: FileConfig, userInfo: any = {}, allowWebPFormat = false): Promise<FileResult> {
         if (!allowWebPFormat && fileUrl.indexOf('&tp=webp') >= 0) fileUrl = fileUrl.replace('&tp=webp', '');
-        let fileName = savefileName ? savefileName : path.basename(fileUrl);
+        const fileName = savefileName ? savefileName : path.basename(fileUrl);
         try {
             const downloadResult = await axios.get(fileUrl, { responseType: 'arraybuffer' });
             if (downloadResult.data) {

package/src/localfile.ts

@@ -1,6 +1,7 @@
 import { FileBase } from "./file";
 import fs from 'fs';
 import path from 'path';
+import { pipeline } from 'stream/promises';
 import { FileConfig, FileResult } from "./declare";
 export class LocalFile extends FileBase {
     
@@ -13,21 +14,19 @@ export class LocalFile extends FileBase {
      * @param userInfo 
      */
     async saveString2File(data: string | Buffer, fileName: string, saveOption: FileConfig, userInfo: any = {}): Promise<FileResult> {
-        let baseFileName = this.getSaveFileName(saveOption, fileName, userInfo);
+        const baseFileName = this.getSaveFileName(saveOption, fileName, userInfo);
         if (!baseFileName) return { successed: false };
-        let fullFileName = path.resolve(saveOption.basefolder || '', baseFileName);
-        let _saveDir = path.dirname(fullFileName);
+        const fullFileName = path.resolve(saveOption.basefolder || '', baseFileName);
+        const _saveDir = path.dirname(fullFileName);
         ///创建本地文件夹
         if (!this.mkdirsSync(_saveDir)) return { successed: false };
         return new Promise(resolve => {
-            fs.writeFile(fullFileName, data as any, (error) => {
-                return resolve({ successed: error == null, filePath: fullFileName })
-            })
+            fs.writeFile(fullFileName, data as any, (error:any) =>  resolve({ successed: !error , filePath: fullFileName, error }) )
         });
     }
 
     async getTemporaryToken(expiresSeconds?: number, permission?: string): Promise<string> {
-        throw new Error("Method not implemented.");
+       return 'localtoken'
     }
     /**
      * 读取文件对象并保存至本地存储
@@ -38,35 +37,33 @@ export class LocalFile extends FileBase {
      * @returns 
      */
     async saveFileStream(file: any, fileName: any, saveOption: FileConfig, userInfo: any): Promise<FileResult> {
-        let baseFileName = this.getSaveFileName(saveOption, fileName, userInfo);
+        const baseFileName = this.getSaveFileName(saveOption, fileName, userInfo);
         if (!baseFileName) return { successed: false };
-        let fullFileName = path.resolve(saveOption.basefolder || '', baseFileName);
-        let _saveDir = path.dirname(fullFileName);
+        const fullFileName = path.resolve(saveOption.basefolder || '', baseFileName);
+        const _saveDir = path.dirname(fullFileName);
         ///创建本地文件夹
         if (!this.mkdirsSync(_saveDir)) return { successed: false };
-        file.pipe(fs.createWriteStream(fullFileName));
-        return { successed: true, filePath: fullFileName };
+        try {
+            await pipeline(file, fs.createWriteStream(fullFileName));
+            return { successed: true, filePath: fullFileName };
+        } catch (error: any) {
+            return { successed: false, filePath: fullFileName, error  };
+        }
     }
     /**
      * 删除指定文件
      * @param filepath 
      */
     async deleteFile(filepath: string | string[]): Promise<{ successed: boolean, error?: any }> {
-        return new Promise(reslove=>{
+        try {
             if (Array.isArray(filepath)) {
-                for (const f of filepath) {
-                    fs.unlink(f, (err: any) => {
-                        if (err) console.log('delete file error', err)
-                    })
-                }
+                await Promise.all(filepath.map(f => fs.promises.unlink(f)));
             } else {
-                fs.unlink(filepath, (err: any) => {
-                    if (err) console.log('delete file error', err)
-                })
+                await fs.promises.unlink(filepath);
             }
-            return reslove({ successed: true })
-        })
-        
-
+            return { successed: true };
+        } catch (error) {
+            return { successed: false, error };
+        }
     }
 }

package/src/uploader.ts

@@ -37,15 +37,15 @@ class LocalUploader{
                 req.shortpath = destinationFolder;
                 ////如果目录不存在，则创建目录
                 destinationFolder = path.join(this.uploadconfig.dest, destinationFolder);
-                if (!fs.existsSync(destinationFolder)) this.fileUtilily.mkdirsSync(path.resolve(destinationFolder))
-                cb(null, destinationFolder)
+                if (fs.existsSync(destinationFolder) || this.fileUtilily.mkdirsSync(path.resolve(destinationFolder))) return cb(null, destinationFolder);
+                cb('如果目录不存在，创建失败', destinationFolder)
             },
             //给上传文件重命名，获取添加后缀名
             filename: (req: any, file: any, cb: any) => {
                 let saveOption = req.fileconfig; //this.config.mapping[filetype];
                 if (!saveOption) {
                     req.fileerror = { successed: false, errmsg: "filetype not configurated in upload setting" };
-                    cb("filetype not configurated in upload setting", null);
+                    return cb("filetype not configurated in upload setting", null);
                 }
                 let finalFile = this.fileUtilily.getSaveOnlyFileName(saveOption, file.originalname);
                 req.shortpath = path.join(req.shortpath, finalFile);