[add] File controller

[optimize] replace PATCH method with PUT to reuse Model classes
[fix] some detail bugs

Signed-off-by: TechQuery <shiy2008@gmail.com>

Author: TechQuery

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kaiyuanshe/openhackathon-service",
-    "version": "0.21.1",
+    "version": "0.22.0",
     "license": "LGPL-3.0",
     "author": "shiy2008@gmail.com",
     "description": "RESTful API service scaffold based on Node.js & TypeScript",
@@ -10,6 +10,8 @@
         "node": ">=22"
     },
     "dependencies": {
+        "@aws-sdk/client-s3": "^3.821.0",
+        "@aws-sdk/s3-request-presigner": "^3.821.0",
         "@koa/cors": "^5.0.0",
         "@koa/multer": "^4.0.0",
         "@koa/router": "^13.1.0",

pnpm-lock.yaml

@@ -10,8 +10,8 @@ import {
     OnNull,
     OnUndefined,
     Param,
-    Patch,
     Post,
+    Put,
     QueryParams
 } from 'routing-controllers';
 import { ResponseSchema } from 'routing-controllers-openapi';
@@ -61,7 +61,7 @@ export class AnnouncementController {
         return saved;
     }
 
-    @Patch('/:id')
+    @Put('/:id')
     @Authorized()
     @ResponseSchema(Announcement)
     async updateOne(

source/controller/Announcement.ts

@@ -8,8 +8,8 @@ import {
     JsonController,
     NotFoundError,
     Param,
-    Patch,
     Post,
+    Put,
     QueryParams
 } from 'routing-controllers';
 import { ResponseSchema } from 'routing-controllers-openapi';
@@ -47,7 +47,7 @@ export class EnrollmentController {
         return store.findOneBy({ createdBy });
     }
 
-    @Patch('/:id')
+    @Put('/:id')
     @Authorized()
     @ResponseSchema(Enrollment)
     async updateOne(

source/controller/Enrollment.ts

@@ -0,0 +1,47 @@
+import { DeleteObjectCommand, PutObjectCommand } from '@aws-sdk/client-s3';
+import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
+import {
+    Authorized,
+    Controller,
+    CurrentUser,
+    Delete,
+    HttpCode,
+    OnUndefined,
+    Param,
+    Post
+} from 'routing-controllers';
+import { ResponseSchema } from 'routing-controllers-openapi';
+
+import { SignedLink, User } from '../model';
+import { AWS_S3_BUCKET, AWS_S3_PUBLIC_HOST, s3Client } from '../utility';
+
+@Controller('/file')
+export class FileController {
+    @Post('/signed-link/:path(.*)')
+    @Authorized()
+    @HttpCode(201)
+    @ResponseSchema(SignedLink)
+    async createSignedLink(
+        @CurrentUser() { id }: User,
+        @Param('path') path: string
+    ) {
+        const Key = `user/${id}/${path}`;
+
+        const command = new PutObjectCommand({ Bucket: AWS_S3_BUCKET, Key });
+
+        const putLink = await getSignedUrl(s3Client, command);
+
+        return { putLink, getLink: `${AWS_S3_PUBLIC_HOST}/${Key}` };
+    }
+
+    @Delete('/:path(.*)')
+    @Authorized()
+    @OnUndefined(204)
+    async deleteFile(@CurrentUser() { id }: User, @Param('path') path: string) {
+        const Key = `user/${id}/${path}`;
+
+        const command = new DeleteObjectCommand({ Bucket: AWS_S3_BUCKET, Key });
+
+        await s3Client.send(command);
+    }
+}

source/controller/File.ts

@@ -21,7 +21,6 @@ import {
     dataSource,
     Hackathon,
     HackathonFilter,
-    HackathonInput,
     HackathonListChunk,
     StaffType,
     User
@@ -60,7 +59,7 @@ export class HackathonController {
     async updateOne(
         @CurrentUser() updatedBy: User,
         @Param('name') name: string,
-        @Body() newData: HackathonInput
+        @Body() newData: Hackathon
     ) {
         const old = await store.findOne({
             where: { name },
@@ -124,7 +123,7 @@ export class HackathonController {
     @ResponseSchema(Hackathon)
     async createOne(
         @CurrentUser() createdBy: User,
-        @Body() hackathon: HackathonInput
+        @Body() hackathon: Hackathon
     ) {
         const saved = await store.save({ ...hackathon, createdBy });
 

source/controller/Hackathon.ts

@@ -1,5 +1,3 @@
-import 'core-js/full/array/from-async';
-
 import { githubClient, User as GitHubUser } from 'mobx-github';
 import { Body, HttpCode, JsonController, Post } from 'routing-controllers';
 import { ResponseSchema } from 'routing-controllers-openapi';

source/controller/OAuth.ts

@@ -9,8 +9,8 @@ import {
     NotFoundError,
     OnUndefined,
     Param,
-    Patch,
     Post,
+    Put,
     QueryParams
 } from 'routing-controllers';
 import { ResponseSchema } from 'routing-controllers-openapi';
@@ -59,7 +59,7 @@ export class OrganizerController {
         return saved;
     }
 
-    @Patch('/:id')
+    @Put('/:id')
     @Authorized()
     @ResponseSchema(Organizer)
     async updateOne(

source/controller/Organizer.ts

@@ -10,7 +10,6 @@ import {
     NotFoundError,
     OnUndefined,
     Param,
-    Patch,
     Put,
     QueryParams
 } from 'routing-controllers';
@@ -96,7 +95,7 @@ export class StaffController {
         });
     }
 
-    @Patch('/:uid')
+    @Put('/:uid')
     @Authorized()
     @ResponseSchema(Staff)
     async updateOne(

source/controller/Staff.ts

@@ -11,8 +11,8 @@ import {
     OnNull,
     OnUndefined,
     Param,
-    Patch,
     Post,
+    Put,
     QueryParams
 } from 'routing-controllers';
 import { ResponseSchema } from 'routing-controllers-openapi';
@@ -92,7 +92,7 @@ export class TeamController {
         return saved;
     }
 
-    @Patch('/:id')
+    @Put('/:id')
     @Authorized()
     @ResponseSchema(Team)
     async updateOne(