chore(release): 1.1.6 [skip ci]

.dockerignore

@@ -0,0 +1,7 @@
+.*
+!.npmrc
+!.swcrc
+build
+coverage
+node_modules
+Dockerfile

.env.example

@@ -1,3 +1,4 @@
+COMPOSE_PROJECT_NAME=thream-file-uploads-api
 API_KEY=apiKeySecret
 API_URL=http://localhost:8000
 HOST=0.0.0.0

.eslintrc.json

@@ -1,16 +1,13 @@
 {
   "extends": ["conventions", "prettier"],
   "plugins": ["prettier", "import", "unicorn"],
+  "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "project": "./tsconfig.json"
   },
-  "env": {
-    "node": true
-  },
   "rules": {
     "prettier/prettier": "error",
     "import/extensions": ["error", "always"],
-    "unicorn/prevent-abbreviations": "error",
-    "unicorn/prefer-node-protocol": "error"
+    "unicorn/prevent-abbreviations": "error"
   }
 }

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 <!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. -->
 
-## What changes this PR introduce?
+# What changes this PR introduce?
 
 ## List any relevant issue numbers
 

.github/workflows/build.yml

@@ -10,16 +10,18 @@ jobs:
   build:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v3.0.0'
+      - uses: 'actions/checkout@v3.5.3'
 
-      - name: 'Use Node.js'
-        uses: 'actions/setup-node@v3.0.0'
+      - name: 'Setup Node.js'
+        uses: 'actions/setup-node@v3.6.0'
         with:
-          node-version: '16.x'
+          node-version: '20.x'
           cache: 'npm'
 
-      - name: 'Install'
-        run: 'npm install'
+      - name: 'Install dependencies'
+        run: 'npm clean-install'
 
       - name: 'Build'
         run: 'npm run build'
+
+      - run: 'npm run build:typescript'

.github/workflows/lint.yml

@@ -10,16 +10,16 @@ jobs:
   lint:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v3.0.0'
+      - uses: 'actions/checkout@v3.5.3'
 
-      - name: 'Use Node.js'
-        uses: 'actions/setup-node@v3.0.0'
+      - name: 'Setup Node.js'
+        uses: 'actions/setup-node@v3.6.0'
         with:
-          node-version: '16.x'
+          node-version: '20.x'
           cache: 'npm'
 
-      - name: 'Install'
-        run: 'npm install'
+      - name: 'Install dependencies'
+        run: 'npm clean-install'
 
       - name: 'lint:commit'
         run: 'npm run lint:commit -- --to "${{ github.sha }}"'
@@ -30,8 +30,8 @@ jobs:
       - name: 'lint:markdown'
         run: 'npm run lint:markdown'
 
-      - name: 'lint:typescript'
-        run: 'npm run lint:typescript'
+      - name: 'lint:eslint'
+        run: 'npm run lint:eslint'
 
       - name: 'lint:prettier'
         run: 'npm run lint:prettier'

.github/workflows/release.yml

@@ -8,30 +8,32 @@ jobs:
   release:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v3.0.0'
+      - uses: 'actions/checkout@v3.5.3'
         with:
           fetch-depth: 0
           persist-credentials: false
 
       - name: 'Import GPG key'
-        uses: 'crazy-max/ghaction-import-gpg@v3.2.0'
+        uses: 'crazy-max/ghaction-import-gpg@v5.3.0'
         with:
-          gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
-          git-user-signingkey: true
-          git-commit-gpgsign: true
+          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+          git_user_signingkey: true
+          git_commit_gpgsign: true
 
-      - name: 'Use Node.js'
-        uses: 'actions/setup-node@v3.0.0'
+      - name: 'Setup Node.js'
+        uses: 'actions/setup-node@v3.6.0'
         with:
-          node-version: '16.x'
+          node-version: '20.x'
           cache: 'npm'
 
-      - name: 'Install'
-        run: 'npm install'
+      - name: 'Install dependencies'
+        run: 'npm clean-install'
 
       - name: 'Build'
         run: 'npm run build'
 
+      - run: 'npm run build:typescript'
+
       - name: 'Release'
         run: 'npm run release'
         env:

.husky/pre-commit

@@ -3,3 +3,4 @@
 
 npm run lint:staged
 npm run build
+npm run build:typescript

.lintstagedrc.json

@@ -2,5 +2,5 @@
   "*": ["editorconfig-checker"],
   "*.{js,jsx,ts,tsx}": ["prettier --write", "eslint --fix"],
   "*.{json,jsonc,yml,yaml}": ["prettier --write"],
-  "*.md": ["prettier --write", "markdownlint --dot --fix"]
+  "*.{md,mdx}": ["prettier --write", "markdownlint-cli2 --fix"]
 }

.markdownlint-cli2.jsonc

@@ -0,0 +1,11 @@
+{
+  "config": {
+    "extends": "markdownlint/style/prettier",
+    "relative-links": true,
+    "default": true,
+    "MD033": false
+  },
+  "globs": ["**/*.{md,mdx}"],
+  "ignores": ["**/node_modules"],
+  "customRules": ["markdownlint-rule-relative-links"]
+}

.markdownlint.json

@@ -1,6 +0,0 @@
-{
-  "default": true,
-  "MD013": false,
-  "MD033": false,
-  "MD041": false
-}

.swcrc

@@ -1,22 +1,13 @@
 {
+  "sourceMaps": true,
   "jsc": {
     "parser": {
       "syntax": "typescript",
-      "decorators": true,
       "dynamicImport": true
     },
-    "transform": {
-      "legacyDecorator": true,
-      "decoratorMetadata": true
-    },
-    "target": "es2022",
-    "loose": true
+    "target": "es2022"
   },
   "module": {
-    "type": "es6",
-    "strict": false,
-    "strictMode": true,
-    "lazy": false,
-    "noInterop": false
+    "type": "es6"
   }
 }

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-contact@divlo.fr.
+<contact@theoludwig.fr>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

@@ -29,28 +29,4 @@ If you're adding new features to **Thream/file-uploads-api**, please include tes
 
 ## Commits
 
-The commit message guidelines respect
-[@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional)
-and [Semantic Versioning](https://semver.org/) for releases.
-
-### Types
-
-Types define which kind of changes you made to the project.
-
-| Types    | Description                                                                                                  |
-| -------- | ------------------------------------------------------------------------------------------------------------ |
-| feat     | A new feature.                                                                                               |
-| fix      | A bug fix.                                                                                                   |
-| docs     | Documentation only changes.                                                                                  |
-| style    | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).      |
-| refactor | A code change that neither fixes a bug nor adds a feature.                                                   |
-| perf     | A code change that improves performance.                                                                     |
-| test     | Adding missing tests or correcting existing tests.                                                           |
-| build    | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm).         |
-| ci       | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs). |
-| chore    | Other changes that don't modify src or test files.                                                           |
-| revert   | Reverts a previous commit.                                                                                   |
-
-### Scopes
-
-Scopes define what part of the code changed.
+The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.

Dockerfile

@@ -0,0 +1,26 @@
+FROM node:20.5.0 AS builder-dependencies
+WORKDIR /usr/src/application
+COPY ./package*.json ./
+RUN npm clean-install
+
+FROM node:20.5.0 AS runner-dependencies
+WORKDIR /usr/src/application
+ENV NODE_ENV=production
+COPY ./package*.json ./
+RUN npm clean-install --omit=dev --ignore-scripts
+
+FROM node:20.5.0 AS builder
+WORKDIR /usr/src/application
+COPY --from=builder-dependencies /usr/src/application/node_modules ./node_modules
+COPY ./ ./
+RUN npm run build
+
+FROM gcr.io/distroless/nodejs20-debian11:latest AS runner
+WORKDIR /usr/src/application
+ENV NODE_ENV=production
+ENV NODE_OPTIONS=--enable-source-maps
+COPY --from=runner-dependencies /usr/src/application/node_modules ./node_modules
+COPY --from=builder /usr/src/application/package.json ./package.json
+COPY --from=builder /usr/src/application/build ./build
+COPY --from=builder /usr/src/application/uploads ./uploads
+CMD ["./build/index.js"]

README.md

@@ -1,4 +1,4 @@
-<h1 align="center"><a href="https://file-uploads-api.thream.divlo.fr/documentation">Thream/file-uploads-api</a></h1>
+<h1 align="center"><a href="https://file-uploads-api.thream.theoludwig.fr/documentation">Thream/file-uploads-api</a></h1>
 
 <p align="center">
   <a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" /></a>
@@ -27,7 +27,7 @@ Thream's application programming interface (API) to upload files.
 
 ```sh
 # Clone the repository
-git clone https://github.com/Thream/file-uploads-api.git
+git clone git@github.com:Thream/file-uploads-api.git
 
 # Go to the project root
 cd file-uploads-api
@@ -50,7 +50,13 @@ npm run dev
 
 #### Services started
 
-- API : `http://localhost:8000`
+- `file-uploads-api`: <http://127.0.0.1:8000>
+
+### Production environment (with [Docker](https://www.docker.com/))
+
+```sh
+docker compose up --build
+```
 
 ## 💡 Contributing
 

docker-compose.yml

@@ -0,0 +1,11 @@
+services:
+  thream-file-uploads-api:
+    container_name: ${COMPOSE_PROJECT_NAME}
+    image: 'thream-file-uploads-api'
+    restart: 'unless-stopped'
+    network_mode: 'host'
+    build:
+      context: './'
+    env_file: '.env'
+    volumes:
+      - './uploads:/usr/src/application/uploads'

package.json

@@ -1,9 +1,12 @@
 {
   "name": "@thream/file-uploads-api",
-  "version": "1.1.0",
+  "version": "1.1.6",
   "description": "Thream's application programming interface to upload files.",
   "private": true,
   "type": "module",
+  "imports": {
+    "#src/*": "./build/*"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/Thream/file-uploads-api"
@@ -13,62 +16,66 @@
     "npm": ">=8.0.0"
   },
   "scripts": {
-    "build": "rimraf ./build && swc ./src --out-dir ./build && tsc",
+    "build": "rimraf ./build && swc ./src --out-dir ./build",
     "build:dev": "swc ./src --out-dir ./build --watch",
-    "start": "node build/index.js",
-    "dev": "concurrently -k -n \"TypeScript,Node\" -p \"[{name}]\" -c \"blue,green\" \"npm run build:dev\" \"cross-env NODE_ENV=development nodemon build/index.js\"",
+    "build:typescript": "tsc",
+    "start": "node --enable-source-maps build/index.js",
+    "dev": "concurrently -k -n \"TypeScript,Node\" -p \"[{name}]\" -c \"blue,green\" \"npm run build:dev\" \"cross-env NODE_ENV=development node --watch --enable-source-maps build/index.js\"",
     "lint:commit": "commitlint",
     "lint:editorconfig": "editorconfig-checker",
-    "lint:markdown": "markdownlint \"**/*.md\" --dot --ignore-path \".gitignore\"",
-    "lint:typescript": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
-    "lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
+    "lint:markdown": "markdownlint-cli2",
+    "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
+    "lint:prettier": "prettier . --check",
     "lint:staged": "lint-staged",
     "release": "semantic-release",
     "postinstall": "husky install"
   },
   "dependencies": {
-    "@sinclair/typebox": "0.23.5",
-    "dotenv": "16.0.1",
-    "fastify": "4.2.0",
-    "@fastify/cors": "8.0.0",
-    "@fastify/helmet": "9.1.0",
-    "@fastify/multipart": "7.1.0",
-    "fastify-plugin": "3.0.1",
-    "@fastify/rate-limit": "7.0.0",
-    "@fastify/sensible": "5.1.0",
-    "@fastify/static": "6.4.0",
-    "@fastify/swagger": "7.4.0",
+    "@fastify/cors": "8.3.0",
+    "@fastify/helmet": "11.0.0",
+    "@fastify/multipart": "7.6.0",
+    "@fastify/rate-limit": "8.0.3",
+    "@fastify/sensible": "5.2.0",
+    "@fastify/static": "6.10.2",
+    "@fastify/swagger": "8.8.0",
+    "@fastify/swagger-ui": "1.9.2",
+    "@sinclair/typebox": "0.29.6",
+    "dotenv": "16.3.1",
+    "fastify": "4.20.0",
+    "fastify-plugin": "4.5.1",
     "http-errors": "2.0.0",
-    "read-pkg": "7.1.0"
+    "read-pkg": "8.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "17.0.3",
-    "@commitlint/config-conventional": "17.0.3",
-    "@saithodev/semantic-release-backmerge": "2.1.2",
+    "@commitlint/cli": "17.6.7",
+    "@commitlint/config-conventional": "17.6.7",
+    "@saithodev/semantic-release-backmerge": "3.2.0",
     "@semantic-release/git": "10.0.1",
-    "@swc/cli": "0.1.57",
-    "@swc/core": "1.2.207",
+    "@swc/cli": "0.1.62",
+    "@swc/core": "1.3.70",
+    "@tsconfig/strictest": "2.0.1",
     "@types/busboy": "1.5.0",
-    "@types/http-errors": "1.8.2",
-    "@types/node": "18.0.0",
-    "@typescript-eslint/eslint-plugin": "5.30.0",
-    "concurrently": "7.2.2",
+    "@types/http-errors": "2.0.1",
+    "@types/node": "20.4.3",
+    "@typescript-eslint/eslint-plugin": "6.1.0",
+    "chokidar": "3.5.3",
+    "concurrently": "8.2.0",
     "cross-env": "7.0.3",
-    "editorconfig-checker": "4.0.2",
-    "eslint": "8.18.0",
-    "eslint-config-conventions": "2.0.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-prettier": "4.1.0",
-    "eslint-plugin-promise": "6.0.0",
-    "eslint-plugin-unicorn": "42.0.0",
-    "husky": "8.0.1",
-    "lint-staged": "13.0.3",
-    "markdownlint-cli": "0.31.1",
-    "nodemon": "2.0.18",
-    "prettier": "2.7.1",
-    "rimraf": "3.0.2",
-    "semantic-release": "19.0.3",
-    "typescript": "4.7.4"
+    "editorconfig-checker": "5.1.1",
+    "eslint": "8.45.0",
+    "eslint-config-conventions": "11.0.1",
+    "eslint-config-prettier": "8.8.0",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-prettier": "5.0.0",
+    "eslint-plugin-promise": "6.1.1",
+    "eslint-plugin-unicorn": "48.0.0",
+    "husky": "8.0.3",
+    "lint-staged": "13.2.3",
+    "markdownlint-cli2": "0.8.1",
+    "markdownlint-rule-relative-links": "2.1.0",
+    "prettier": "3.0.0",
+    "rimraf": "5.0.1",
+    "semantic-release": "21.0.7",
+    "typescript": "5.1.6"
   }
 }

src/application.ts

@@ -4,18 +4,20 @@ import dotenv from 'dotenv'
 import fastify from 'fastify'
 import fastifyCors from '@fastify/cors'
 import fastifySwagger from '@fastify/swagger'
+import fastifySwaggerUI from '@fastify/swagger-ui'
 import fastifyHelmet from '@fastify/helmet'
 import fastifyRateLimit from '@fastify/rate-limit'
 import fastifySensible from '@fastify/sensible'
 import fastifyStatic from '@fastify/static'
+import { readPackage } from 'read-pkg'
 
-import { services } from './services/index.js'
-import { swaggerOptions } from './tools/configurations/swaggerOptions.js'
-import { UPLOADS_URL } from './tools/configurations/index.js'
+import { services } from '#src/services/index.js'
+import { UPLOADS_URL } from '#src/tools/configurations.js'
 
 dotenv.config()
+const packageJSON = await readPackage()
 export const application = fastify({
-  logger: process.env.NODE_ENV === 'development',
+  logger: process.env['NODE_ENV'] === 'development',
   ajv: {
     customOptions: {
       strict: 'log',
@@ -38,5 +40,28 @@ await application.register(fastifyStatic, {
   root: fileURLToPath(UPLOADS_URL),
   prefix: '/uploads/'
 })
-await application.register(fastifySwagger, swaggerOptions)
+await application.register(fastifySwagger, {
+  openapi: {
+    info: {
+      title: packageJSON.name,
+      description: packageJSON.description,
+      version: packageJSON.version
+    },
+    tags: [{ name: 'users' }, { name: 'guilds' }, { name: 'messages' }],
+    components: {
+      securitySchemes: {
+        apiKeyAuth: {
+          type: 'apiKey',
+          name: 'X-API-KEY',
+          in: 'header'
+        }
+      }
+    }
+  },
+  hideUntagged: true
+})
+await application.register(fastifySwaggerUI, {
+  routePrefix: '/documentation',
+  staticCSP: true
+})
 await application.register(services)

src/index.ts

@@ -1,8 +1,8 @@
-import { application } from './application.js'
-import { HOST, PORT } from './tools/configurations/index.js'
+import { application } from '#src/application.js'
+import { HOST, PORT } from '#src/tools/configurations.js'
 
 const address = await application.listen({
   port: PORT,
   host: HOST
 })
-console.log('\u001B[36m%s\u001B[0m', `🚀  Server listening at ${address}`)
+console.log(`Server listening at ${address}`)

src/services/index.ts

@@ -1,6 +1,6 @@
-import { FastifyPluginAsync } from 'fastify'
+import type { FastifyPluginAsync } from 'fastify'
 
-import { uploadsService } from './uploads/index.js'
+import { uploadsService } from '#src/services/uploads/index.js'
 
 export const services: FastifyPluginAsync = async (fastify) => {
   await fastify.register(uploadsService)

src/services/uploads/guilds/delete.ts

@@ -1,13 +1,13 @@
-import { FastifyPluginAsync, FastifySchema } from 'fastify'
+import type { FastifyPluginAsync, FastifySchema } from 'fastify'
 import { Type } from '@sinclair/typebox'
 
-import { fastifyErrors } from '../../../models/utils.js'
-import verifyAPIKey from '../../../tools/plugins/verifyAPIKey.js'
+import { fastifyErrors } from '#src/models/utils.js'
+import verifyAPIKey from '#src/tools/plugins/verifyAPIKey.js'
+import type { DeleteParameters } from '#src/tools/utils/deleteUploadedFile.js'
 import {
-  DeleteParameters,
   deleteParameters,
   deleteUploadedFile
-} from '../../../tools/utils/deleteUploadedFile.js'
+} from '#src/tools/utils/deleteUploadedFile.js'
 
 export const deleteServiceSchema: FastifySchema = {
   tags: ['guilds'] as string[],

src/services/uploads/guilds/get.ts

@@ -1,9 +1,10 @@
 import path from 'node:path'
 
-import { FastifyPluginAsync, FastifySchema } from 'fastify'
-import { Static, Type } from '@sinclair/typebox'
+import type { FastifyPluginAsync, FastifySchema } from 'fastify'
+import type { Static } from '@sinclair/typebox'
+import { Type } from '@sinclair/typebox'
 
-import { fastifyErrors } from '../../../models/utils.js'
+import { fastifyErrors } from '#src/models/utils.js'
 
 const parameters = Type.Object({
   file: Type.String()

src/services/uploads/guilds/post.ts

@@ -1,14 +1,14 @@
 import { Type } from '@sinclair/typebox'
-import { FastifyPluginAsync, FastifySchema } from 'fastify'
+import type { FastifyPluginAsync, FastifySchema } from 'fastify'
 import fastifyMultipart from '@fastify/multipart'
 
-import { fastifyErrors } from '../../../models/utils.js'
-import { uploadFile } from '../../../tools/utils/uploadFile.js'
+import { fastifyErrors } from '#src/models/utils.js'
+import { uploadFile } from '#src/tools/utils/uploadFile.js'
 import {
   MAXIMUM_IMAGE_SIZE,
   SUPPORTED_IMAGE_MIMETYPE
-} from '../../../tools/configurations/index.js'
-import verifyAPIKey from '../../../tools/plugins/verifyAPIKey.js'
+} from '#src/tools/configurations.js'
+import verifyAPIKey from '#src/tools/plugins/verifyAPIKey.js'
 
 const postServiceSchema: FastifySchema = {
   description: 'Uploads guild icon',

src/services/uploads/index.ts

@@ -1,14 +1,14 @@
-import { FastifyPluginAsync } from 'fastify'
+import type { FastifyPluginAsync } from 'fastify'
 
-import { deleteGuildsUploadsService } from './guilds/delete.js'
-import { getGuildsUploadsService } from './guilds/get.js'
-import { postGuildsUploadsIconService } from './guilds/post.js'
-import { deleteMessagesUploadsService } from './messages/delete.js'
-import { getMessagesUploadsService } from './messages/get.js'
-import { postMessagesUploadsService } from './messages/post.js'
-import { deleteUsersUploadsService } from './users/delete.js'
-import { getUsersUploadsService } from './users/get.js'
-import { postUsersUploadsLogoService } from './users/post.js'
+import { deleteGuildsUploadsService } from '#src/services/uploads/guilds/delete.js'
+import { getGuildsUploadsService } from '#src/services/uploads/guilds/get.js'
+import { postGuildsUploadsIconService } from '#src/services/uploads/guilds/post.js'
+import { deleteMessagesUploadsService } from '#src/services/uploads/messages/delete.js'
+import { getMessagesUploadsService } from '#src/services/uploads/messages/get.js'
+import { postMessagesUploadsService } from '#src/services/uploads/messages/post.js'
+import { deleteUsersUploadsService } from '#src/services/uploads/users/delete.js'
+import { getUsersUploadsService } from '#src/services/uploads/users/get.js'
+import { postUsersUploadsLogoService } from '#src/services/uploads/users/post.js'
 
 export const uploadsService: FastifyPluginAsync = async (fastify) => {
   await fastify.register(deleteGuildsUploadsService)

src/services/uploads/messages/delete.ts

@@ -1,13 +1,13 @@
-import { FastifyPluginAsync, FastifySchema } from 'fastify'
+import type { FastifyPluginAsync, FastifySchema } from 'fastify'
 import { Type } from '@sinclair/typebox'
 
-import { fastifyErrors } from '../../../models/utils.js'
-import verifyAPIKey from '../../../tools/plugins/verifyAPIKey.js'
+import { fastifyErrors } from '#src/models/utils.js'
+import verifyAPIKey from '#src/tools/plugins/verifyAPIKey.js'
+import type { DeleteParameters } from '#src/tools/utils/deleteUploadedFile.js'
 import {
-  DeleteParameters,
   deleteParameters,
   deleteUploadedFile
-} from '../../../tools/utils/deleteUploadedFile.js'
+} from '#src/tools/utils/deleteUploadedFile.js'
 
 export const deleteServiceSchema: FastifySchema = {
   tags: ['messages'] as string[],

src/services/uploads/messages/get.ts

@@ -1,9 +1,10 @@
 import path from 'node:path'
 
-import { FastifyPluginAsync, FastifySchema } from 'fastify'
-import { Static, Type } from '@sinclair/typebox'
+import type { FastifyPluginAsync, FastifySchema } from 'fastify'
+import type { Static } from '@sinclair/typebox'
+import { Type } from '@sinclair/typebox'
 
-import { fastifyErrors } from '../../../models/utils.js'
+import { fastifyErrors } from '#src/models/utils.js'
 
 const parameters = Type.Object({
   file: Type.String()

src/services/uploads/messages/post.ts

@@ -1,11 +1,11 @@
 import { Type } from '@sinclair/typebox'
-import { FastifyPluginAsync, FastifySchema } from 'fastify'
+import type { FastifyPluginAsync, FastifySchema } from 'fastify'
 import fastifyMultipart from '@fastify/multipart'
 
-import { fastifyErrors } from '../../../models/utils.js'
-import { uploadFile } from '../../../tools/utils/uploadFile.js'
-import { MAXIMUM_IMAGE_SIZE } from '../../../tools/configurations/index.js'
-import verifyAPIKey from '../../../tools/plugins/verifyAPIKey.js'
+import { fastifyErrors } from '#src/models/utils.js'
+import { uploadFile } from '#src/tools/utils/uploadFile.js'
+import { MAXIMUM_IMAGE_SIZE } from '#src/tools/configurations.js'
+import verifyAPIKey from '#src/tools/plugins/verifyAPIKey.js'
 
 const postServiceSchema: FastifySchema = {
   description: 'Uploads message file',

src/services/uploads/users/delete.ts

@@ -1,13 +1,13 @@
-import { FastifyPluginAsync, FastifySchema } from 'fastify'
+import type { FastifyPluginAsync, FastifySchema } from 'fastify'
 import { Type } from '@sinclair/typebox'
 
-import { fastifyErrors } from '../../../models/utils.js'
-import verifyAPIKey from '../../../tools/plugins/verifyAPIKey.js'
+import { fastifyErrors } from '#src/models/utils.js'
+import verifyAPIKey from '#src/tools/plugins/verifyAPIKey.js'
+import type { DeleteParameters } from '#src/tools/utils/deleteUploadedFile.js'
 import {
-  DeleteParameters,
   deleteParameters,
   deleteUploadedFile
-} from '../../../tools/utils/deleteUploadedFile.js'
+} from '#src/tools/utils/deleteUploadedFile.js'
 
 export const deleteServiceSchema: FastifySchema = {
   tags: ['users'] as string[],

src/services/uploads/users/get.ts

@@ -1,9 +1,10 @@
 import path from 'node:path'
 
-import { FastifyPluginAsync, FastifySchema } from 'fastify'
-import { Static, Type } from '@sinclair/typebox'
+import type { FastifyPluginAsync, FastifySchema } from 'fastify'
+import type { Static } from '@sinclair/typebox'
+import { Type } from '@sinclair/typebox'
 
-import { fastifyErrors } from '../../../models/utils.js'
+import { fastifyErrors } from '#src/models/utils.js'
 
 const parameters = Type.Object({
   file: Type.String()

src/services/uploads/users/post.ts

@@ -1,14 +1,14 @@
 import { Type } from '@sinclair/typebox'
-import { FastifyPluginAsync, FastifySchema } from 'fastify'
+import type { FastifyPluginAsync, FastifySchema } from 'fastify'
 import fastifyMultipart from '@fastify/multipart'
 
-import { fastifyErrors } from '../../../models/utils.js'
-import { uploadFile } from '../../../tools/utils/uploadFile.js'
+import { fastifyErrors } from '#src/models/utils.js'
+import { uploadFile } from '#src/tools/utils/uploadFile.js'
 import {
   MAXIMUM_IMAGE_SIZE,
   SUPPORTED_IMAGE_MIMETYPE
-} from '../../../tools/configurations/index.js'
-import verifyAPIKey from '../../../tools/plugins/verifyAPIKey.js'
+} from '#src/tools/configurations.js'
+import verifyAPIKey from '#src/tools/plugins/verifyAPIKey.js'
 
 const postServiceSchema: FastifySchema = {
   description: 'Uploads user logo',

src/tools/configurations.ts

@@ -4,12 +4,12 @@ import dotenv from 'dotenv'
 
 dotenv.config()
 
-export const PORT = parseInt(process.env.PORT ?? '8000', 10)
-export const HOST = process.env.HOST ?? '0.0.0.0'
-export const API_URL = process.env.API_URL ?? `http://${HOST}:${PORT}`
-export const API_KEY = process.env.API_KEY ?? 'apiKeySecret'
+export const PORT = Number.parseInt(process.env['PORT'] ?? '8000', 10)
+export const HOST = process.env['HOST'] ?? '0.0.0.0'
+export const API_URL = process.env['API_URL'] ?? `http://${HOST}:${PORT}`
+export const API_KEY = process.env['API_KEY'] ?? 'apiKeySecret'
 
-export const SRC_URL = new URL('../../', import.meta.url)
+export const SRC_URL = new URL('../', import.meta.url)
 export const ROOT_URL = new URL('../', SRC_URL)
 export const UPLOADS_URL = new URL('./uploads/', ROOT_URL)
 

src/tools/configurations/swaggerOptions.ts

@@ -1,31 +0,0 @@
-import dotenv from 'dotenv'
-import { readPackage } from 'read-pkg'
-import { FastifyDynamicSwaggerOptions } from '@fastify/swagger'
-
-dotenv.config()
-
-const packageJSON = await readPackage()
-
-export const swaggerOptions: FastifyDynamicSwaggerOptions = {
-  routePrefix: '/documentation',
-  openapi: {
-    info: {
-      title: packageJSON.name,
-      description: packageJSON.description,
-      version: packageJSON.version
-    },
-    tags: [{ name: 'guilds' }, { name: 'messages' }, { name: 'users' }],
-    components: {
-      securitySchemes: {
-        apiKeyAuth: {
-          type: 'apiKey',
-          name: 'X-API-KEY',
-          in: 'header'
-        }
-      }
-    }
-  },
-  exposeRoute: true,
-  staticCSP: true,
-  hideUntagged: true
-}

src/tools/plugins/verifyAPIKey.ts

@@ -1,7 +1,7 @@
 import fastifyPlugin from 'fastify-plugin'
 import httpErrors from 'http-errors'
 
-import { API_KEY } from '../configurations/index.js'
+import { API_KEY } from '#src/tools/configurations.js'
 
 const { Unauthorized, Forbidden } = httpErrors
 
@@ -13,8 +13,8 @@ declare module 'fastify' {
 
 export default fastifyPlugin(
   async (fastify) => {
-    await fastify.decorateRequest('apiKey', null)
-    await fastify.addHook('onRequest', async (request) => {
+    fastify.decorateRequest('apiKey', undefined)
+    fastify.addHook('onRequest', async (request) => {
       const apiKey = request.headers['x-api-key']
       if (apiKey == null || typeof apiKey !== 'string') {
         throw new Unauthorized()

src/tools/utils/deleteUploadedFile.ts

@@ -1,17 +1,18 @@
-import { IncomingMessage, Server, ServerResponse } from 'node:http'
+import type { IncomingMessage, Server, ServerResponse } from 'node:http'
 import { fileURLToPath } from 'node:url'
 import fs from 'node:fs'
 
-import { Static, Type } from '@sinclair/typebox'
-import {
+import type { Static } from '@sinclair/typebox'
+import { Type } from '@sinclair/typebox'
+import type {
+  FastifyBaseLogger,
   FastifyInstance,
-  FastifyLoggerInstance,
   FastifyReply,
   FastifyRequest,
   FastifyTypeProviderDefault
 } from 'fastify'
 
-import { isExistingFile } from './isExistingFile.js'
+import { isExistingFile } from '#src/tools/utils/isExistingFile.js'
 
 export const deleteParameters = Type.Object({
   file: Type.String()
@@ -22,10 +23,10 @@ export type DeleteParameters = Static<typeof deleteParameters>
 export interface DeleteUploadedFileOptions {
   folder: 'guilds' | 'messages' | 'users'
   fastify: FastifyInstance<
-    Server,
+    Server<typeof IncomingMessage, typeof ServerResponse>,
     IncomingMessage,
-    ServerResponse,
-    FastifyLoggerInstance,
+    ServerResponse<IncomingMessage>,
+    FastifyBaseLogger,
     FastifyTypeProviderDefault
   >
   request: FastifyRequest<{ Params: DeleteParameters }>

src/tools/utils/uploadFile.ts

@@ -2,10 +2,10 @@ import fs from 'node:fs'
 import { URL } from 'node:url'
 import { randomUUID } from 'node:crypto'
 
-import { FastifyInstance, FastifyRequest } from 'fastify'
-import { Multipart } from '@fastify/multipart'
+import type { FastifyInstance, FastifyRequest } from 'fastify'
+import type { SavedMultipartFile } from '@fastify/multipart'
 
-import { API_URL, ROOT_URL } from '../configurations/index.js'
+import { API_URL, ROOT_URL } from '#src/tools/configurations.js'
 
 export interface UploadFileOptions {
   folderInUploadsFolder: 'guilds' | 'messages' | 'users'
@@ -33,7 +33,7 @@ export const uploadFile = async (
     maximumFileSize,
     supportedFileMimetype
   } = options
-  let files: Multipart[] = []
+  let files: SavedMultipartFile[] = []
   try {
     files = await request.saveRequestFiles({
       limits: {
@@ -42,14 +42,15 @@ export const uploadFile = async (
       }
     })
   } catch (error) {
+    console.error(error)
     throw fastify.httpErrors.requestHeaderFieldsTooLarge(
       `File should be less than ${maximumFileSize}mb.`
     )
   }
-  if (files.length !== 1) {
+  const file = files[0]
+  if (files.length !== 1 || file == null) {
     throw fastify.httpErrors.badRequest('You must upload at most one file.')
   }
-  const file = files[0]
   if (
     supportedFileMimetype != null &&
     !supportedFileMimetype.includes(file.mimetype)
@@ -60,6 +61,9 @@ export const uploadFile = async (
   }
   const splitedMimetype = file.mimetype.split('/')
   const fileExtension = splitedMimetype[1]
+  if (fileExtension == null) {
+    throw fastify.httpErrors.badRequest('The file extension is not valid.')
+  }
   const filePath = `uploads/${folderInUploadsFolder}/${randomUUID()}.${fileExtension}`
   const fileURL = new URL(filePath, ROOT_URL)
   const pathToStoreInDatabase = `${API_URL}/${filePath}`

tsconfig.json

@@ -1,13 +1,18 @@
 {
+  "extends": "@tsconfig/strictest/tsconfig.json",
   "compilerOptions": {
     "target": "ESNext",
     "module": "ESNext",
     "lib": ["ESNext"],
-    "moduleResolution": "node",
+    "moduleResolution": "Node",
     "outDir": "./build",
     "rootDir": "./src",
+    "baseUrl": ".",
+    "paths": {
+      "#src/*": ["./src/*"]
+    },
     "noEmit": true,
-    "strict": true,
-    "esModuleInterop": true
+    "exactOptionalPropertyTypes": false,
+    "checkJs": false
   }
 }