[add] File model & controller based on AWS S3 compatible API

[add] WebAuthn model & controller based on Passwordless ID
[add] Email One-Time-Password based on Supabase SDK

Author: TechQuery

.dockerignore

@@ -1,8 +1,9 @@
 ReadMe.md
 node_modules/
 dist/
-.*/
+.*
 !.npmrc
+!.env*
 start.sh
 eslint.config.mjs
 *.pem

.env.example

@@ -0,0 +1,13 @@
+APP_SECRET = random_string
+DATABASE_URL = postgresql://your-account:[email protected]:5432/postgres
+
+GITHUB_PAT = # set by admin
+
+SUPABASE_PROJECT_URL = https://your-id.supabase.co
+SUPABASE_ANON_KEY = your.jwt
+
+AWS_S3_END_POINT = https://your-id.r2.cloudflarestorage.com
+AWS_S3_BUCKET = your-bucket-name
+AWS_S3_ACCESS_KEY_ID = your-access-key-id
+AWS_S3_SECRET_ACCESS_KEY = your-secret-access-key
+AWS_S3_PUBLIC_HOST = https://pub-your-id.r2.dev

.gitignore

@@ -5,5 +5,6 @@ test/client.ts
 dist/
 type/*.d.ts
 .env*
+!.env.example
 .data/
 .vscode/settings.json

ReadMe.md

@@ -46,17 +46,24 @@
 
 ## API Usage
 
--   Entry: http://localhost:8080/
--   Document: http://localhost:8080/docs/
--   Schema: http://localhost:8080/docs/spec/
--   Type: https://github.com/idea2app/REST-Node-ts/pkgs/npm/rest-node-ts
+- Entry: http://localhost:8080/
+- Document: http://localhost:8080/docs/
+- Schema: http://localhost:8080/docs/spec/
+- Type: https://github.com/idea2app/REST-Node-ts/pkgs/npm/rest-node-ts
 
 ## Environment variables
 
-|      Name      |            Usage             |
-| :------------: | :--------------------------: |
-|  `APP_SECRET`  |   encrypt Password & Token   |
-| `DATABASE_URL` | PostgreSQL connection string |
+|            Name            |            Usage             |
+| :------------------------: | :--------------------------: |
+|        `APP_SECRET`        |   encrypt Password & Token   |
+|       `DATABASE_URL`       | PostgreSQL connection string |
+|   `SUPABASE_PROJECT_URL`   |  [Supabase][24] project URL  |
+|    `SUPABASE_ANON_KEY`     |      Supabase anon key       |
+|     `AWS_S3_END_POINT`     |  [AWS S3][25] endpoint URL   |
+|      `AWS_S3_BUCKET`       |      AWS S3 bucket name      |
+|   `AWS_S3_ACCESS_KEY_ID`   |     AWS S3 access key id     |
+| `AWS_S3_SECRET_ACCESS_KEY` |   AWS S3 secret access key   |
+|    `AWS_S3_PUBLIC_HOST`    |      AWS S3 public host      |
 
 ## Development
 
@@ -143,3 +150,5 @@ git push origin master --tags
 [21]: https://github.com/kaiyuanshe/kaiyuanshe.github.io/blob/bb4675a56bf1d6b207231313da5ed0af7cf0ebd6/.github/workflows/pull-request.yml#L32-L56
 [22]: https://github.com/idea2app/REST-Node-ts/issues/new/choose
 [23]: https://github.com/idea2app/REST-Node-ts/projects
+[24]: https://supabase.com/
+[25]: https://aws.amazon.com/s3/

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@idea2app/rest-node-ts",
-    "version": "1.0.0",
+    "version": "1.2.0",
     "license": "LGPL-3.0",
     "author": "[email protected]",
     "description": "RESTful API service scaffold based on Node.js & TypeScript",
@@ -18,9 +18,15 @@
         "node": ">=22"
     },
     "dependencies": {
+        "@aws-sdk/client-s3": "^3.779.0",
+        "@aws-sdk/s3-request-presigner": "^3.779.0",
         "@koa/cors": "^5.0.0",
         "@koa/multer": "^3.1.0",
         "@koa/router": "^13.1.0",
+        "@passwordless-id/webauthn": "^2.3.0",
+        "@smithy/smithy-client": "^4.1.6",
+        "@supabase/auth-js": "^2.69.1",
+        "@supabase/supabase-js": "^2.49.4",
         "class-transformer": "^0.5.1",
         "class-validator": "^0.14.1",
         "cross-env": "^7.0.3",
@@ -95,6 +101,7 @@
         "preset": "ts-jest"
     },
     "scripts": {
+        "install": "mv .env.example .env  ||  true",
         "prepare": "husky || true",
         "dev": "cross-env TS_NODE_TRANSPILE_ONLY=true  node -r ts-node/register --watch source/",
         "lint": "lint-staged",