@midwayjs/upload 3.0.0-beta.11 → 3.0.0-beta.12

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-beta.12](https://github.com/midwayjs/midway/compare/v3.0.0-beta.11...v3.0.0-beta.12) (2021-12-28)
+
+
+### Features
+
+* custom error code & add @Files/@Fields ([#1438](https://github.com/midwayjs/midway/issues/1438)) ([b0032af](https://github.com/midwayjs/midway/commit/b0032afd2fa9ea0416fe69f4bd0c1a58bea5314e))
+* support throw err status ([#1440](https://github.com/midwayjs/midway/issues/1440)) ([7b98110](https://github.com/midwayjs/midway/commit/7b98110d65c5287a8fcb3eb5356dea2d7a32cee9))
+
+
+
+
+
 # [3.0.0-beta.11](https://github.com/midwayjs/midway/compare/v3.0.0-beta.10...v3.0.0-beta.11) (2021-12-21)
 
 **Note:** Version bump only for package @midwayjs/upload

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 下支持同时上传多个文件
@@ -79,4 +69,4 @@ export const upload = {
   // tmpdir: string，上传的文件临时存储路径
   tmpdir: join(tmpdir(), 'midway-upload-files'),
 }
-```
+```

package/dist/config/config.default.js

@@ -1,11 +1,10 @@
 "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");
 exports.upload = {
-    mode: interface_1.UploadMode.File,
+    mode: 'file',
     fileSize: '10mb',
     whitelist: [
         // images

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,5 @@
 export { UploadConfiguration as Configuration } from './configuration';
 export * from './interface';
 export * from './middleware';
+export * from './error';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -15,4 +15,5 @@ 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);
 //# sourceMappingURL=index.js.map

package/dist/interface.d.ts

@@ -1,20 +1,16 @@
 /// <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;
 }
-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,6 +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;
-    getName(): string;
+    static getName(): string;
 }
 //# sourceMappingURL=middleware.d.ts.map

package/dist/middleware.js

@@ -41,17 +41,10 @@ let UploadMiddleware = class UploadMiddleware {
         ctx.fields = {};
         let body;
         if (this.isReadableStream(req, isExpress)) {
-            if (mode === _1.UploadMode.Stream) {
+            if (mode === 'stream') {
                 const { fields, fileInfo } = await (0, upload_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;
@@ -79,36 +72,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 = files.map((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}`);
+                (0, fs_1.writeFileSync)(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,7 +131,7 @@ let UploadMiddleware = class UploadMiddleware {
         }
         return whitelist.includes(ext);
     }
-    getName() {
+    static getName() {
         return 'upload';
     }
 };

package/dist/upload.d.ts

@@ -7,7 +7,7 @@ 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[];

package/dist/upload.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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/upload",
-  "version": "3.0.0-beta.11",
+  "version": "3.0.0-beta.12",
   "description": "Midway Component for upload",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -25,14 +25,14 @@
     "raw-body": "^2.4.1"
   },
   "devDependencies": {
-    "@midwayjs/core": "^3.0.0-beta.11",
-    "@midwayjs/decorator": "^3.0.0-beta.11",
-    "@midwayjs/express": "^3.0.0-beta.11",
-    "@midwayjs/faas": "^3.0.0-beta.11",
-    "@midwayjs/koa": "^3.0.0-beta.11",
-    "@midwayjs/mock": "^3.0.0-beta.11",
-    "@midwayjs/serverless-app": "^3.0.0-beta.11",
-    "@midwayjs/web": "^3.0.0-beta.11"
+    "@midwayjs/core": "^3.0.0-beta.12",
+    "@midwayjs/decorator": "^3.0.0-beta.12",
+    "@midwayjs/express": "^3.0.0-beta.12",
+    "@midwayjs/faas": "^3.0.0-beta.12",
+    "@midwayjs/koa": "^3.0.0-beta.12",
+    "@midwayjs/mock": "^3.0.0-beta.12",
+    "@midwayjs/serverless-app": "^3.0.0-beta.12",
+    "@midwayjs/web": "^3.0.0-beta.12"
   },
-  "gitHead": "a2b066fd500e815e799e7f421cd216f12e0e9f8e"
+  "gitHead": "1c46e53eb934248007eeb7fe3920f5ac24e272c6"
 }