- Added @Files decorator.

- Made some possible breaking changes to @Req. This will now target the ctx.request object and not ctx.req.

Author: iyobo

.eslintrc.js

@@ -260,6 +260,18 @@ export class FooController {
         return body;
     }
 
+  @Post('/fieldsAndFiles')
+  async createWithFiles( 
+    @Body({required: true}) body: FooCreateInput, 
+    @Files() files: Record<string,File>) {
+
+    // POST /api/v.../foo/orDie2
+
+    // Any file uploaded will appear in files, indexed by the name of the file.
+    
+    return body;
+  }
+
 
     @Delete('/:id')
     @Flow([aMiddleware, bMiddleware])
@@ -503,6 +515,11 @@ Injects the koa request object. useful when streaming data up to server
 
 Injects the koa response object. useful when streaming data down to client.
 
+#### @Files()
+
+Injects the request files object. All files uploaded during the request can be found here, indexed by file field name.
+
+
 #### @Ctx()
 
 Injects the whole koa context. For a more descriptive endpoint handler/action, avoid doing this if you can. Opt for more specific injections.

README.md

@@ -0,0 +1,11 @@
+module.exports = {
+    root: true,
+    parser: '@typescript-eslint/parser',
+    plugins: [
+        '@typescript-eslint',
+    ],
+    extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/recommended',
+    ],
+};

eslintrc.js

@@ -37,7 +37,7 @@
     "@hapi/boom": "^9.0.0",
     "class-transformer": "*",
     "class-validator": "*",
-    "koa": "^2.x",
+    "koa": "^2.x || ^3.x",
     "koa-body": "*",
     "koa-router": "*",
     "koa-session": "*",
@@ -53,15 +53,15 @@
     "@types/lodash": "^4.14.149",
     "@types/node": "^13.7.1",
     "@types/supertest": "^2.0.8",
-    "@typescript-eslint/eslint-plugin": "^2.19.2",
-    "@typescript-eslint/parser": "^2.19.2",
+    "@typescript-eslint/eslint-plugin": "^4.28.2",
+    "@typescript-eslint/parser": "^4.28.2",
     "class-validator": "^0.x",
-    "eslint": "^6.8.0",
-    "jest": "^25.1.0",
+    "eslint": "^7.30.0",
+    "jest": "^27.0.6",
     "supertest": "^4.0.2",
-    "ts-jest": "^25.2.0",
+    "ts-jest": "^27.0.3",
     "ts-node": "^8.6.2",
-    "typescript": "^3.7.5",
+    "typescript": "^4.3.5",
     "typescript-eslint": "0.0.1-alpha.0"
   }
 }

package.json

@@ -223,14 +223,30 @@ export function Req(injectOptions?: string | Record<string, any>) {
   ): void {
     addArgumentInjectMeta({
       index,
-      injectSource: "req",
+      injectSource: "request",
       injectOptions,
       methodName,
       object
     });
   };
 }
 
+export function Files() {
+  return function (
+    object: Record<string, any>,
+    methodName: string,
+    index: number
+  ): void {
+    addArgumentInjectMeta({
+      index,
+      injectSource: "request",
+      injectOptions: "files",
+      methodName,
+      object
+    });
+  };
+}
+
 export function Res(injectOptions?: string | Record<string, any>) {
   return function (
     object: Record<string, any>,

src/decorators.ts

@@ -9,6 +9,7 @@ import Koa from 'koa';
 import Router from 'koa-router';
 import bodyParser from 'koa-body';
 import {addArgumentInjectMeta} from './util/tools';
+const unparsed = require('koa-body/unparsed.js');
 
 export type KoaBodyOptions = {
   // Patch request body to Node's ctx.req, default false
@@ -264,9 +265,12 @@ export const bootstrapControllers = async (
     });
   }
 
-  //body parer
+  //body parser
   if (options.bodyParser !== false) {
-    app.use(bodyParser(options.bodyParser as KoaBodyOptions));
+    app.use(bodyParser({...options.bodyParser as KoaBodyOptions,
+      // includeUnparsed: true,
+      multipart: true
+    }));
   }
 
   if (options.attachRoutes) {
@@ -292,6 +296,7 @@ export {
   Flow,
   Get,
   Header,
+  Files,
   CurrentUser,
   Params,
   Patch,

src/index.ts

@@ -5,7 +5,6 @@ let nativeServer;
 let testServer: request.SuperTest<request.Test>;
 beforeAll(async () => {
 
-
   const {app, router} = await bootstrapControllers({
     basePath: "/api",
     controllers: [__dirname + "/util/controllers/**/*.ts"],
@@ -49,16 +48,24 @@ describe("Arguments", () => {
 
   describe("body", () => {
     it("whole object can be injected", async () => {
-      const payload = { foo: "Ijebu garri is the best for soaking" };
+      const payload = {foo: "Ijebu garri is the best for soaking"};
       const response = await testServer
         .post("/api/v2/arg/bodySimple")
         .send(payload)
         .expect(200);
       expect(response.body).toEqual(payload);
     });
 
+    it("can be set with field", async () => {
+      const response = await testServer
+        .post("/api/v2/arg/bodySimple")
+        .field({abc: 123})
+        .expect(200);
+      expect(response.body.abc).toEqual("123");
+    });
+
     it("specific subfield can be injected", async () => {
-      const payload = { foo: "Ijebu garri is the best for soaking" };
+      const payload = {foo: "Ijebu garri is the best for soaking"};
       const response = await testServer
         .post("/api/v2/arg/bodySpecific")
         .send(payload)
@@ -178,15 +185,61 @@ describe("Arguments", () => {
   });
 
   describe("req", () => {
-    it("works", async () => {
+
+    it("can set headers", async () => {
       const response = await testServer
         .post("/api/v2/arg/req")
         .set("foo", "bar")
         .expect(200);
 
       // returns a serialized req object
-      expect(Buffer.isBuffer(response.body)).toEqual(true);
+      // expect(Buffer.isBuffer(response.body)).toEqual(true);
+      expect(response.body).toBeDefined();
+      expect(response.body.foo).toEqual('bar');
     });
+
+    it("Buffer can be uploaded", async () => {
+      const buffer = Buffer.from('some file data');
+      const response = await testServer
+        .post("/api/v2/arg/uploadBuffer")
+        .set("foo", "bar")
+        .attach('testFile', buffer)
+        .expect(200);
+
+      // returns a serialized req object
+      expect(response.body).toEqual({testFile: 'some file data'});
+    });
+
+    it("File decorator injects files", async () => {
+
+      const response = await testServer
+        .post("/api/v2/arg/uploadFile")
+        .set("foo", "bar")
+        .attach('testFile', 'src/tests/attachments/image.png')
+        .expect(200);
+
+      // returns a serialized req object
+      expect(response.body.testFile).toBeDefined();
+      expect(response.body.testFile.name).toEqual('image.png');
+      expect(response.body.testFile.type).toEqual('image/png');
+      expect(response.body.testFile.size).toEqual(41569);
+    });
+
+    it("Uploaded files can also be found in @Req.files", async () => {
+
+      const response = await testServer
+        .post("/api/v2/arg/uploadFile2")
+        .set("foo", "bar")
+        .attach('testFile', 'src/tests/attachments/image.png')
+        .expect(200);
+
+      // returns a serialized req object
+      expect(response.body.testFile).toBeDefined();
+      expect(response.body.testFile.name).toEqual('image.png');
+      expect(response.body.testFile.type).toEqual('image/png');
+      expect(response.body.testFile.size).toEqual(41569);
+    });
+
   });
 
   describe("res", () => {

src/tests/arguments.test.ts

@@ -4,7 +4,7 @@ import {
   Body,
   Controller,
   Ctx,
-  CurrentUser,
+  CurrentUser, Files,
   Flow,
   Get,
   Header,
@@ -124,7 +124,23 @@ export class ArgController {
 
   @Post('/req')
   async req(@Req() req: Request) {
-    return req;
+
+    return req.header;
+  }
+
+  @Post('/uploadBuffer')
+  async uploadBuffer(@Ctx() ctx, @Req() req: Request) {
+    return req.body;
+  }
+
+  @Post('/uploadFile')
+  async uploadFile(@Ctx() ctx, @Files() files: Record<string,File>) {
+    return files;
+  }
+
+  @Post('/uploadFile2')
+  async uploadFile2(@Ctx() ctx, @Req() req: Request) {
+    return req.files;
   }
 
   @Post('/res')