@midwayjs/upload 3.0.0-beta.9 → 3.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013 - Now midwayjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/{readme.md → README.md}

@@ -10,21 +10,12 @@ tnpm i @midwayjs/upload --save
 ```
 2. 在 configuration 中引入组件,
 ```ts
-import * as upload from '../../../../src';
+import * as upload from '@midwayjs/upload';
 @Configuration({
   imports: [
     // ...other components
     upload
   ],
-  importConfigs: [
-    {
-      default: {
-        upload: {                       // 上传组件的配置
-          mode: upload.UploadMode.File, // 默认为 file 模式
-        }
-      }
-    }
-  ]
 })
 export class AutoConfiguration {}
 ```
@@ -38,20 +29,19 @@ export class HomeController {
   ctx;
 
   @Post('/upload')
-  async upload() {
-    const { files, fields } = this.ctx;
+  async upload(@Files() files: upload.UploadFileInfo[], @Fields() fields) {
     /*
     files = [
       {
         filename: 'test.pdf',        // 文件原名
         data: '/var/tmp/xxx.pdf',    // mode 为 file 时为服务器临时文件地址
-        fieldname: 'test1',          // 表单 field 名
+        fieldName: 'test1',          // 表单 field 名
         mimeType: 'application/pdf', // mime
       },
       {
         filename: 'test.pdf',        // 文件原名
         data: ReadStream,    // mode 为 stream 时为服务器临时文件地址
-        fieldname: 'test2',          // 表单 field 名
+        fieldName: 'test2',          // 表单 field 名
         mimeType: 'application/pdf', // mime
       },
       // ...file 下支持同时上传多个文件
@@ -78,5 +68,7 @@ export const upload = {
   whitelist: null,
   // tmpdir: string，上传的文件临时存储路径
   tmpdir: join(tmpdir(), 'midway-upload-files'),
+  // cleanTimeout: number，上传的文件在临时目录中多久之后自动删除，默认为 5 分钟
+  cleanTimeout: 5 * 60 * 1000,
 }
-```
+```

package/dist/config/config.default.js

@@ -1,44 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.upload = void 0;
-const interface_1 = require("../interface");
 const path_1 = require("path");
 const os_1 = require("os");
+const constants_1 = require("../constants");
 exports.upload = {
-    mode: interface_1.UploadMode.File,
+    mode: 'file',
     fileSize: '10mb',
-    whitelist: [
-        // images
-        '.jpg',
-        '.jpeg',
-        '.png',
-        '.gif',
-        '.bmp',
-        '.wbmp',
-        '.webp',
-        '.tif',
-        '.psd',
-        // text
-        '.svg',
-        '.js',
-        '.jsx',
-        '.json',
-        '.css',
-        '.less',
-        '.html',
-        '.htm',
-        '.xml',
-        '.pdf',
-        // tar
-        '.zip',
-        '.gz',
-        '.tgz',
-        '.gzip',
-        // video
-        '.mp3',
-        '.mp4',
-        '.avi',
-    ],
+    whitelist: constants_1.uploadWhiteList,
     tmpdir: (0, path_1.join)((0, os_1.tmpdir)(), 'midway-upload-files'),
+    cleanTimeout: 5 * 60 * 1000,
 };
 //# sourceMappingURL=config.default.js.map

package/dist/configuration.d.ts

@@ -1,7 +1,9 @@
 import { MidwayApplicationManager } from '@midwayjs/core';
+import { UploadOptions } from './interface';
 export declare class UploadConfiguration {
     applicationManager: MidwayApplicationManager;
-    uploadConfig: any;
+    uploadConfig: UploadOptions;
     onReady(): Promise<void>;
+    onStop(): Promise<void>;
 }
 //# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -14,12 +14,15 @@ const decorator_1 = require("@midwayjs/decorator");
 const DefaultConfig = require("./config/config.default");
 const core_1 = require("@midwayjs/core");
 const middleware_1 = require("./middleware");
-const fs_extra_1 = require("fs-extra");
+const utils_1 = require("./utils");
 let UploadConfiguration = class UploadConfiguration {
     async onReady() {
-        const { tmpdir } = this.uploadConfig;
+        const { tmpdir, cleanTimeout } = this.uploadConfig;
         if (tmpdir) {
-            await (0, fs_extra_1.ensureDir)(tmpdir);
+            await (0, utils_1.ensureDir)(tmpdir);
+            if (cleanTimeout) {
+                (0, utils_1.autoRemoveUploadTmpFile)(tmpdir, cleanTimeout);
+            }
         }
         this.applicationManager
             .getApplications(['koa', 'faas', 'express', 'egg'])
@@ -27,6 +30,9 @@ let UploadConfiguration = class UploadConfiguration {
             app.useMiddleware(middleware_1.UploadMiddleware);
         });
     }
+    async onStop() {
+        await (0, utils_1.stopAutoRemoveUploadTmpFile)();
+    }
 };
 __decorate([
     (0, decorator_1.Inject)(),

package/dist/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const uploadWhiteList: string[];
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadWhiteList = void 0;
+exports.uploadWhiteList = [
+    // images
+    '.jpg',
+    '.jpeg',
+    '.png',
+    '.gif',
+    '.bmp',
+    '.wbmp',
+    '.webp',
+    '.tif',
+    '.psd',
+    // text
+    '.svg',
+    '.js',
+    '.jsx',
+    '.json',
+    '.css',
+    '.less',
+    '.html',
+    '.htm',
+    '.xml',
+    '.pdf',
+    // tar
+    '.zip',
+    '.gz',
+    '.tgz',
+    '.gzip',
+    // video
+    '.mp3',
+    '.mp4',
+    '.avi',
+];
+//# sourceMappingURL=constants.js.map

package/dist/error.d.ts

@@ -0,0 +1,5 @@
+import { httpError } from '@midwayjs/core';
+export declare class MultipartInvalidFilenameError extends httpError.BadRequestError {
+    constructor(filename: string);
+}
+//# sourceMappingURL=error.d.ts.map

package/dist/error.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultipartInvalidFilenameError = void 0;
+const core_1 = require("@midwayjs/core");
+class MultipartInvalidFilenameError extends core_1.httpError.BadRequestError {
+    constructor(filename) {
+        super(`Invalid update file name ${filename}, please check it`);
+    }
+}
+exports.MultipartInvalidFilenameError = MultipartInvalidFilenameError;
+//# sourceMappingURL=error.js.map

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 export { UploadConfiguration as Configuration } from './configuration';
 export * from './interface';
 export * from './middleware';
+export * from './error';
+export * from './constants';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -15,4 +15,6 @@ var configuration_1 = require("./configuration");
 Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.UploadConfiguration; } });
 __exportStar(require("./interface"), exports);
 __exportStar(require("./middleware"), exports);
+__exportStar(require("./error"), exports);
+__exportStar(require("./constants"), exports);
 //# sourceMappingURL=index.js.map

package/dist/interface.d.ts

@@ -1,20 +1,17 @@
 /// <reference types="node" />
 import { Readable } from "stream";
-export declare enum UploadMode {
-    Stream = "stream",
-    File = "file",
-    Buffer = "buffer"
-}
+export declare type UploadMode = 'stream' | 'file';
 export interface UploadOptions {
     mode?: UploadMode;
     fileSize?: string;
     whitelist?: string[];
     tmpdir?: string;
+    cleanTimeout?: number;
 }
-export interface UploadFileInfo {
+export interface UploadFileInfo<T> {
     filename: string;
-    fieldname: string;
+    fieldName: string;
     mimeType: string;
-    data: Buffer | Readable | string;
+    data: T extends string ? string : Readable;
 }
 //# sourceMappingURL=interface.d.ts.map

package/dist/interface.js

@@ -1,10 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UploadMode = void 0;
-var UploadMode;
-(function (UploadMode) {
-    UploadMode["Stream"] = "stream";
-    UploadMode["File"] = "file";
-    UploadMode["Buffer"] = "buffer";
-})(UploadMode = exports.UploadMode || (exports.UploadMode = {}));
 //# sourceMappingURL=interface.js.map

package/dist/middleware.d.ts

@@ -8,5 +8,6 @@ export declare class UploadMiddleware implements IMiddleware<any, any> {
     getUploadBoundary(request: any): false | string;
     isReadableStream(req: any, isExpress: any): boolean;
     checkExt(filename: any): boolean;
+    static getName(): string;
 }
 //# sourceMappingURL=middleware.d.ts.map

package/dist/middleware.js

@@ -15,8 +15,9 @@ const path_1 = require("path");
 const fs_1 = require("fs");
 const stream_1 = require("stream");
 const _1 = require(".");
-const upload_1 = require("./upload");
+const parse_1 = require("./parse");
 const getRawBody = require("raw-body");
+const { unlink, writeFile } = fs_1.promises;
 let UploadMiddleware = class UploadMiddleware {
     resolve(app) {
         if (app.getFrameworkType() === decorator_1.MidwayFrameworkType.WEB_EXPRESS) {
@@ -39,19 +40,31 @@ let UploadMiddleware = class UploadMiddleware {
             return next();
         }
         ctx.fields = {};
+        ctx.files = [];
+        ctx.cleanupRequestFiles = async () => {
+            var _a;
+            if (!((_a = ctx.files) === null || _a === void 0 ? void 0 : _a.length)) {
+                return [];
+            }
+            return Promise.all(ctx.files.map(async (fileInfo) => {
+                if (typeof fileInfo.data !== 'string') {
+                    return false;
+                }
+                try {
+                    await unlink(fileInfo.data);
+                    return true;
+                }
+                catch (_a) {
+                    return false;
+                }
+            }));
+        };
         let body;
         if (this.isReadableStream(req, isExpress)) {
-            if (mode === _1.UploadMode.Stream) {
-                const { fields, fileInfo } = await (0, upload_1.parseFromReadableStream)(req, boundary);
+            if (mode === 'stream') {
+                const { fields, fileInfo } = await (0, parse_1.parseFromReadableStream)(req, boundary);
                 if (!this.checkExt(fileInfo.filename)) {
-                    res.status = 400;
-                    const errorMessage = 'Invalid filename: ' + fileInfo.filename;
-                    const err = new Error(errorMessage);
-                    this.logger.error(err);
-                    if (isExpress) {
-                        return res.sendStatus(400);
-                    }
-                    return;
+                    throw new _1.MultipartInvalidFilenameError(fileInfo.filename);
                 }
                 else {
                     ctx.fields = fields;
@@ -66,7 +79,7 @@ let UploadMiddleware = class UploadMiddleware {
         else {
             body = req.body;
         }
-        const data = await (0, upload_1.parseMultipart)(body, boundary);
+        const data = await (0, parse_1.parseMultipart)(body, boundary);
         if (!data) {
             return next();
         }
@@ -79,36 +92,26 @@ let UploadMiddleware = class UploadMiddleware {
             }
         });
         if (notCheckFile) {
-            res.status = 400;
-            const errorMessage = 'Invalid filename: ' + notCheckFile.filename;
-            const err = new Error(errorMessage);
-            this.logger.error(err);
-            if (isExpress) {
-                return res.sendStatus(400);
-            }
-            return;
+            throw new _1.MultipartInvalidFilenameError(notCheckFile.filename);
         }
-        ctx.files =
-            mode === 'buffer'
-                ? files
-                : files.map((file, index) => {
-                    const { data, filename } = file;
-                    if (mode === _1.UploadMode.File) {
-                        const ext = (0, path_1.extname)(filename);
-                        const tmpFileName = (0, path_1.resolve)(tmpdir, `${requireId}.${index}${ext}`);
-                        (0, fs_1.writeFileSync)(tmpFileName, data, 'binary');
-                        file.data = tmpFileName;
-                    }
-                    else if (mode === _1.UploadMode.Stream) {
-                        file.data = new stream_1.Readable({
-                            read() {
-                                this.push(data);
-                                this.push(null);
-                            },
-                        });
-                    }
-                    return file;
+        ctx.files = await Promise.all(files.map(async (file, index) => {
+            const { data, filename } = file;
+            if (mode === 'file') {
+                const ext = (0, path_1.extname)(filename);
+                const tmpFileName = (0, path_1.resolve)(tmpdir, `${requireId}.${index}${ext}`);
+                await writeFile(tmpFileName, data, 'binary');
+                file.data = tmpFileName;
+            }
+            else if (mode === 'stream') {
+                file.data = new stream_1.Readable({
+                    read() {
+                        this.push(data);
+                        this.push(null);
+                    },
                 });
+            }
+            return file;
+        }));
         return next();
     }
     getUploadBoundary(request) {
@@ -148,6 +151,9 @@ let UploadMiddleware = class UploadMiddleware {
         }
         return whitelist.includes(ext);
     }
+    static getName() {
+        return 'upload';
+    }
 };
 __decorate([
     (0, decorator_1.Config)('upload'),

package/dist/{upload.d.ts → parse.d.ts}

@@ -7,9 +7,9 @@ export declare const parseMultipart: (body: any, boundary: string) => Promise<{
 }>;
 export declare const parseFromReadableStream: (readStream: Readable, boundary: any) => Promise<{
     fields: any;
-    fileInfo: UploadFileInfo;
+    fileInfo: UploadFileInfo<Readable>;
 }>;
 export declare const bufferIndexOf: (buffer: Buffer, search: Buffer, offset?: number) => number;
 export declare const bufferSplit: (buffer: Buffer, separator: Buffer, limit?: number) => Buffer[];
 export declare const parseHead: (headBuf: Buffer) => {};
-//# sourceMappingURL=upload.d.ts.map
+//# sourceMappingURL=parse.d.ts.map

package/dist/{upload.js → parse.js}

@@ -25,7 +25,7 @@ const parseMultipart = async (body, boundary) => {
         files.push({
             filename: head['content-disposition'].filename,
             data,
-            fieldname: head['content-disposition'].name,
+            fieldName: head['content-disposition'].name,
             mimeType: head['content-type'],
         });
     });
@@ -42,7 +42,7 @@ const parseFromReadableStream = (readStream, boundary) => {
     const fileInfo = {
         filename: '',
         data: null,
-        fieldname: '',
+        fieldName: '',
         mimeType: '',
     };
     const emptyBuf = Buffer.alloc(0);
@@ -108,7 +108,7 @@ const parseFromReadableStream = (readStream, boundary) => {
                         continue;
                     }
                     fileInfo.filename = head['content-disposition'].filename;
-                    fileInfo.fieldname = head['content-disposition'].name;
+                    fileInfo.fieldName = head['content-disposition'].name;
                     fileInfo.mimeType = head['content-type'];
                     isTransformFileData = true;
                     lastChunk = data;
@@ -186,4 +186,4 @@ const parseHead = (headBuf) => {
     return head;
 };
 exports.parseHead = parseHead;
-//# sourceMappingURL=upload.js.map
+//# sourceMappingURL=parse.js.map

package/dist/utils.d.ts

@@ -0,0 +1,5 @@
+export declare const autoRemoveUploadTmpFile: (tmpDir: string, cleanTimeout: number) => Promise<void>;
+export declare const stopAutoRemoveUploadTmpFile: () => Promise<void>;
+export declare const checkExists: (path: string) => Promise<boolean>;
+export declare const ensureDir: (dirPath: string) => Promise<boolean>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureDir = exports.checkExists = exports.stopAutoRemoveUploadTmpFile = exports.autoRemoveUploadTmpFile = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const { readdir, access, stat, unlink, mkdir } = fs_1.promises;
+let autoRemoveUploadTmpFileTimeoutHandler;
+let autoRemoveUploadTmpFilePromise;
+const autoRemoveUploadTmpFile = async (tmpDir, cleanTimeout) => {
+    clearTimeout(autoRemoveUploadTmpFileTimeoutHandler);
+    let waitTime = cleanTimeout / 3;
+    if (waitTime < 1000) {
+        waitTime = 1000;
+    }
+    if (autoRemoveUploadTmpFilePromise) {
+        const exists = await (0, exports.checkExists)(tmpDir);
+        if (exists) {
+            const paths = await readdir(tmpDir);
+            const now = Date.now();
+            await Promise.all(paths.map(async (path) => {
+                const filePath = (0, path_1.join)(tmpDir, path);
+                try {
+                    const statInfo = await stat(filePath);
+                    if (statInfo.isFile() && now - statInfo.ctimeMs > cleanTimeout) {
+                        await unlink(filePath);
+                    }
+                }
+                catch (_a) {
+                    return false;
+                }
+            }));
+        }
+    }
+    autoRemoveUploadTmpFileTimeoutHandler = setTimeout(() => {
+        autoRemoveUploadTmpFilePromise = (0, exports.autoRemoveUploadTmpFile)(tmpDir, cleanTimeout);
+    }, waitTime);
+};
+exports.autoRemoveUploadTmpFile = autoRemoveUploadTmpFile;
+const stopAutoRemoveUploadTmpFile = async () => {
+    if (autoRemoveUploadTmpFilePromise) {
+        await autoRemoveUploadTmpFilePromise;
+        autoRemoveUploadTmpFilePromise = null;
+    }
+    clearTimeout(autoRemoveUploadTmpFileTimeoutHandler);
+};
+exports.stopAutoRemoveUploadTmpFile = stopAutoRemoveUploadTmpFile;
+const checkExists = async (path) => {
+    try {
+        await access(path, fs_1.constants.W_OK | fs_1.constants.R_OK);
+        return true;
+    }
+    catch (_a) {
+        return false;
+    }
+};
+exports.checkExists = checkExists;
+const ensureDir = async (dirPath) => {
+    const isExists = await (0, exports.checkExists)(dirPath);
+    if (isExists) {
+        return true;
+    }
+    try {
+        await mkdir(dirPath, { recursive: true });
+        return true;
+    }
+    catch (_a) {
+        return false;
+    }
+};
+exports.ensureDir = ensureDir;
+//# sourceMappingURL=utils.js.map

package/index.d.ts

@@ -0,0 +1,39 @@
+import { UploadFileInfo, UploadOptions } from './dist/index';
+export * from './dist/index';
+
+declare module '@midwayjs/core/dist/interface' {
+  interface MidwayConfig {
+    upload: Partial<UploadOptions>;
+  }
+}
+declare module '@midwayjs/koa/dist/interface' {
+  interface Context {
+    files?: UploadFileInfo<any>[];
+    fields?: { [fieldName: string]: any };
+    cleanupRequestFiles?: () => Promise<Array<boolean>>;
+  }
+}
+
+declare module '@midwayjs/web/dist/interface' {
+  interface Context {
+    files?: UploadFileInfo<any>[];
+    fields?: { [fieldName: string]: any };
+    cleanupRequestFiles?: () => Promise<Array<boolean>>;
+  }
+}
+
+declare module '@midwayjs/faas/dist/interface' {
+  interface Context {
+    files?: UploadFileInfo<any>[];
+    fields?: { [fieldName: string]: any };
+    cleanupRequestFiles?: () => Promise<Array<boolean>>;
+  }
+}
+
+declare module '@midwayjs/express/dist/interface' {
+  interface Context {
+    files?: UploadFileInfo<any>[];
+    fields?: { [fieldName: string]: any };
+    cleanupRequestFiles?: () => Promise<Array<boolean>>;
+  }
+}

package/package.json

@@ -1,37 +1,38 @@
 {
   "name": "@midwayjs/upload",
-  "version": "3.0.0-beta.9",
+  "version": "3.0.0",
   "description": "Midway Component for upload",
   "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "index.d.ts",
   "scripts": {
     "build": "tsc",
-    "test": "node --require=ts-node/register ../../node_modules/.bin/jest",
-    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --coverage --forceExit",
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand --coverage --forceExit",
     "ci": "npm run test"
   },
   "keywords": [],
   "author": "",
   "files": [
     "dist/**/*.js",
-    "dist/**/*.d.ts"
+    "dist/**/*.d.ts",
+    "index.d.ts"
   ],
   "engines": {
     "node": ">=12"
   },
   "license": "MIT",
   "dependencies": {
-    "fs-extra": "^8.0.1",
-    "raw-body": "^2.4.1"
+    "raw-body": "2.4.2"
   },
   "devDependencies": {
-    "@midwayjs/core": "^3.0.0-beta.9",
-    "@midwayjs/decorator": "^3.0.0-beta.9",
-    "@midwayjs/mock": "^3.0.0-beta.9",
-    "@midwayjs/faas": "^3.0.0-beta.9",
-    "@midwayjs/serverless-app": "^3.0.0-beta.9",
-    "@midwayjs/web": "^3.0.0-beta.9",
-    "@midwayjs/koa": "^3.0.0-beta.9",
-    "@midwayjs/express": "^3.0.0-beta.9"
-  }
+    "@midwayjs/core": "^3.0.0",
+    "@midwayjs/decorator": "^3.0.0",
+    "@midwayjs/express": "^3.0.0",
+    "@midwayjs/faas": "^3.0.0",
+    "@midwayjs/koa": "^3.0.0",
+    "@midwayjs/mock": "^3.0.0",
+    "@midwayjs/serverless-app": "^3.0.0",
+    "@midwayjs/web": "^3.0.0"
+  },
+  "gitHead": "55c26029bccf7bbb739fa1597e8f418dafa2caa0"
 }