[add] Team model & controller (#10)

Author: TechQuery

.github/workflows/deploy-production.yml

@@ -30,11 +30,11 @@ jobs:
                   cat > .env <<EOF
                   ${{ secrets.ENV_FILE }}
                   EOF
-            - uses: docker/setup-qemu-action@v2
-            - uses: docker/setup-buildx-action@v2
+            - uses: docker/setup-qemu-action@v3
+            - uses: docker/setup-buildx-action@v3
 
             - name: Build Image
-              uses: docker/build-push-action@v3
+              uses: docker/build-push-action@v6
               with:
                   context: .
                   platforms: linux/amd64

.github/workflows/publish-type.yml

@@ -10,14 +10,14 @@ jobs:
             contents: write
             packages: write
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v4
 
-            - uses: pnpm/action-setup@v2
+            - uses: pnpm/action-setup@v4
               with:
                   version: 9
-            - uses: actions/setup-node@v3
+            - uses: actions/setup-node@v4
               with:
-                  node-version: 18
+                  node-version: 20
                   registry-url: https://npm.pkg.github.com
                   cache: pnpm
             - name: Install, Build & Publish

Dockerfile

@@ -1,6 +1,6 @@
 # Reference: https://pnpm.io/docker#example-1-build-a-bundle-in-a-docker-container
 
-FROM node:18-slim AS base
+FROM node:20-slim AS base
 RUN apt-get update && \
     apt-get install curl -y --no-install-recommends
 ENV PNPM_HOME="/pnpm"

ReadMe.md

@@ -9,7 +9,7 @@
 [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)][6]
 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][7]
 
-## Feature
+## Technology stack
 
 1. HTTP server: [Koa][8]
 2. Controller framework: [Routing Controllers][9]
@@ -18,22 +18,39 @@
 5. API document: [Swagger][13]
 6. Mock API: [OpenAPI backend][14]
 
+## Major features
+
+1. [API entry & Health checking](source/controller/Base.ts)
+2. User management
+    1. [Session](source/controller/User.ts)
+    2. [OAuth sign in](source/controller/OAuth.ts)
+        - recommend to use with [Next SSR middleware][15]
+    3. [Platform Admin](source/controller/Admin.ts)
+3. [Activity logging](source/controller/ActivityLog.ts)
+4. Hackathon management
+    1. [Meta](source/controller/Hackathon.ts)
+    2. [Staff](source/controller/Staff.ts)
+    3. [Organizer](source/controller/Organizer.ts)
+    4. [Enrollment](source/controller/Enrollment.ts)
+5. Team management
+    1. [Meta](source/controller/Team.ts)
+
 ## Best practice
 
 1.  Install GitHub apps in your organization or account:
 
-    1.  [Probot settings][15]: set up Issue labels & Pull Request rules
-    2.  [PR badge][16]: set up Online [VS Code][17] editor entries in Pull Request description
+    1.  [Probot settings][16]: set up Issue labels & Pull Request rules
+    2.  [PR badge][17]: set up Online [VS Code][18] editor entries in Pull Request description
 
-2.  Click the **[<kbd>Use this template</kbd>][18] button** on the top of this GitHub repository's home page, then create your own repository in the app-installed namespace above
+2.  Click the **[<kbd>Use this template</kbd>][19] button** on the top of this GitHub repository's home page, then create your own repository in the app-installed namespace above
 
 3.  Click the **[<kbd>Open in GitHub codespaces</kbd>][8] button** on the top of ReadMe file, then an **online VS Code development environment** will be started immediately
 
-4.  Recommend to add a [Notification step in GitHub actions][19] for your Team IM app
+4.  Recommend to add a [Notification step in GitHub actions][20] for your Team IM app
 
-5.  Remind the PMs & users of your product to submit **Feature/Enhancement** requests or **Bug** reports with [Issue forms][20] instead of IM messages or Mobile Phone calls
+5.  Remind the PMs & users of your product to submit **Feature/Enhancement** requests or **Bug** reports with [Issue forms][21] instead of IM messages or Mobile Phone calls
 
-6.  Collect all these issues into [Project kanbans][21], then create **Pull requests** & add `closes #issue_number` into its description for automation
+6.  Collect all these issues into [Project kanbans][22], then create **Pull requests** & add `closes #issue_number` into its description for automation
 
 ## API Usage
 
@@ -64,7 +81,7 @@ pnpm i
 pnpm dev
 ```
 
-or just press <kbd>F5</kbd> key in [VS Code][17].
+or just press <kbd>F5</kbd> key in [VS Code][18].
 
 ### Migration
 
@@ -125,10 +142,11 @@ git push origin master --tags
 [12]: https://typeorm.io/
 [13]: https://swagger.io/
 [14]: https://github.com/anttiviljami/openapi-backend
-[15]: https://github.com/apps/settings
-[16]: https://pullrequestbadge.com/
-[17]: https://code.visualstudio.com/
-[18]: https://github.com/new?template_name=openhackathon-service&template_owner=kaiyuanshe
-[19]: https://github.com/kaiyuanshe/kaiyuanshe.github.io/blob/bb4675a56bf1d6b207231313da5ed0af7cf0ebd6/.github/workflows/pull-request.yml#L32-L56
-[20]: https://github.com/kaiyuanshe/OpenHackathon-service/issues/new/choose
-[21]: https://github.com/kaiyuanshe/OpenHackathon-service/projects
+[15]: https://github.com/idea2app/Next-SSR-middleware
+[16]: https://github.com/apps/settings
+[17]: https://pullrequestbadge.com/
+[18]: https://code.visualstudio.com/
+[19]: https://github.com/new?template_name=openhackathon-service&template_owner=kaiyuanshe
+[20]: https://github.com/kaiyuanshe/kaiyuanshe.github.io/blob/bb4675a56bf1d6b207231313da5ed0af7cf0ebd6/.github/workflows/pull-request.yml#L32-L56
+[21]: https://github.com/kaiyuanshe/OpenHackathon-service/issues/new/choose
+[22]: https://github.com/kaiyuanshe/OpenHackathon-service/projects

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kaiyuanshe/openhackathon-service",
-    "version": "0.14.0",
+    "version": "0.15.0",
     "license": "LGPL-3.0",
     "author": "shiy2008@gmail.com",
     "description": "RESTful API service scaffold based on Node.js & TypeScript",
@@ -15,13 +15,12 @@
     "source": "source/index.ts",
     "main": "dist/index.js",
     "engines": {
-        "node": ">=18"
+        "node": ">=20"
     },
     "dependencies": {
         "@koa/cors": "^5.0.0",
         "@koa/multer": "^3.0.2",
         "@koa/router": "^13.0.0",
-        "@octokit/openapi-types": "^22.2.0",
         "class-transformer": "^0.5.1",
         "class-validator": "^0.14.1",
         "cross-env": "^7.0.3",
@@ -41,21 +40,22 @@
         "reflect-metadata": "^0.2.2",
         "routing-controllers": "^0.10.4",
         "routing-controllers-openapi": "^4.0.0",
-        "tslib": "^2.6.3",
+        "tslib": "^2.7.0",
         "typeorm": "npm:@helveg/typeorm@^0.3.20",
         "web-utility": "^4.4.0"
     },
     "devDependencies": {
+        "@octokit/openapi-types": "^22.2.0",
         "@types/jsonwebtoken": "^9.0.6",
         "@types/koa": "^2.15.0",
         "@types/koa-logger": "^3.1.5",
-        "@types/node": "^18.19.44",
-        "@typescript-eslint/eslint-plugin": "^8.1.0",
-        "@typescript-eslint/parser": "^8.1.0",
+        "@types/node": "^20.16.1",
+        "@typescript-eslint/eslint-plugin": "^8.2.0",
+        "@typescript-eslint/parser": "^8.2.0",
         "eslint": "^8.57.0",
         "eslint-plugin-simple-import-sort": "^12.1.1",
         "get-git-folder": "^0.1.2",
-        "husky": "^9.1.4",
+        "husky": "^9.1.5",
         "lint-staged": "^15.2.9",
         "prettier": "^3.3.3",
         "sqlite3": "^5.1.7",

pnpm-lock.yaml

@@ -8,7 +8,7 @@ services:
       healthCheckPath: /_health
       envVars:
           - key: NODE_VERSION
-            value: 18.20.4
+            value: 20
           - key: NODE_ENV
             value: production
           - key: DATABASE_URL

render.yaml

@@ -1,12 +1,14 @@
-import { Get, JsonController, QueryParams } from 'routing-controllers';
+import { Get, JsonController, Param, QueryParams } from 'routing-controllers';
 import { ResponseSchema } from 'routing-controllers-openapi';
+import { FindOptionsWhere } from 'typeorm';
 
 import {
     ActivityLog,
     ActivityLogFilter,
     ActivityLogListChunk,
     BaseFilter,
     dataSource,
+    LogableTable,
     Operation,
     User,
     UserRank,
@@ -66,17 +68,37 @@ export class ActivityLogController {
         return { list, count };
     }
 
-    @Get()
+    @Get('/user/:id')
     @ResponseSchema(ActivityLogListChunk)
-    async getList({
-        operation,
-        tableName,
-        recordId,
-        pageSize,
-        pageIndex
-    }: ActivityLogFilter) {
+    getUserList(
+        @Param('id') id: number,
+        @QueryParams() { operation, pageSize, pageIndex }: ActivityLogFilter
+    ) {
+        return this.queryList(
+            { operation, createdBy: { id } },
+            { pageSize, pageIndex }
+        );
+    }
+
+    @Get('/:table/:id')
+    @ResponseSchema(ActivityLogListChunk)
+    getList(
+        @Param('table') tableName: keyof typeof LogableTable,
+        @Param('id') recordId: number,
+        @QueryParams() { operation, pageSize, pageIndex }: ActivityLogFilter
+    ) {
+        return this.queryList(
+            { operation, tableName, recordId },
+            { pageSize, pageIndex }
+        );
+    }
+
+    async queryList(
+        where: FindOptionsWhere<ActivityLog>,
+        { pageSize, pageIndex }: BaseFilter
+    ) {
         const [list, count] = await store.findAndCount({
-            where: { operation, tableName, recordId },
+            where,
             relations: ['createdBy'],
             skip: pageSize * (pageIndex - 1),
             take: pageSize

source/controller/ActivityLog.ts

@@ -42,6 +42,11 @@ export class HackathonController {
             throw new ForbiddenError();
     }
 
+    static async ensureEnrolled(userId: number, hackathonName: string) {
+        if (!(await EnrollmentController.isEnrolled(userId, hackathonName)))
+            throw new ForbiddenError();
+    }
+
     @Patch('/:name')
     @Authorized()
     @ResponseSchema(Hackathon)