23 Commits

Author SHA1 Message Date
e1326bbf8b chore(release): 1.1.6 [skip ci] 2023-07-22 14:27:50 +00:00
5a2bec6706 fix: update dependencies to latest 2023-07-22 16:24:52 +02:00
d83092bd34 chore(release): 1.1.5 [skip ci] 2023-07-02 16:32:22 +00:00
03008a5246 docs: use ssh to clone the repository 2023-07-02 18:30:28 +02:00
4a4eaac3cd chore: enable source maps for easier debugging 2023-07-02 18:28:34 +02:00
eaafa40125 fix: update author - Théo LUDWIG 2023-07-02 18:23:59 +02:00
72d560363e fix: update dependencies to latest 2023-07-02 18:23:20 +02:00
8b62aa726a docs: usage of 127.0.0.1 instead of localhost 2023-05-13 22:49:32 +02:00
9445303630 chore(release): 1.1.4 [skip ci] 2023-05-13 17:58:09 +00:00
621ebfb611 fix: release new version 2023-05-13 19:57:15 +02:00
d08bd2c59c chore: fix release issues 2023-05-13 19:52:44 +02:00
b4f7221fe0 build(deps): update latest 2023-05-13 19:47:36 +02:00
338aeca2e7 chore(release): 1.1.3 [skip ci] 2023-04-02 21:42:57 +00:00
568d4a95a3 ci: update Node.js to v18 2023-04-02 23:41:53 +02:00
4bfe1e3ce6 fix: update dependencies to latest 2023-04-02 23:37:44 +02:00
8a3bbcca18 chore(release): 1.1.2 [skip ci] 2023-01-11 00:09:39 +00:00
79ebeaced3 fix: regression introduced in v1.1.1 2023-01-11 01:08:40 +01:00
c34741d197 chore(release): 1.1.1 [skip ci] 2023-01-10 23:27:12 +00:00
c4e9a2316e fix: update dependencies to latest 2023-01-11 00:24:19 +01:00
c583d987d3 chore(release): 1.1.0 [skip ci] 2022-06-29 03:23:28 +00:00
7ff8d8e347 feat: add DELETE services to delete files uploaded 2022-06-29 05:19:03 +02:00
262c1d76c2 build(deps): update latest 2022-06-29 05:00:35 +02:00
9109842248 chore: configure correctly semantic-release 2022-04-08 21:43:17 +02:00
40 changed files with 6992 additions and 11944 deletions

7
.dockerignore Normal file
View File

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

View File

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

View File

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

View File

@ -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. --> <!-- 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 ## List any relevant issue numbers

View File

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

View File

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

View File

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

View File

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

View File

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

11
.markdownlint-cli2.jsonc Normal file
View File

@ -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"]
}

View File

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

View File

@ -30,6 +30,7 @@
[ [
"@saithodev/semantic-release-backmerge", "@saithodev/semantic-release-backmerge",
{ {
"branches": [{ "from": "master", "to": "develop" }],
"backmergeStrategy": "merge" "backmergeStrategy": "merge"
} }
] ]

15
.swcrc
View File

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

View File

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

View File

@ -29,28 +29,4 @@ If you're adding new features to **Thream/file-uploads-api**, please include tes
## Commits ## Commits
The commit message guidelines respect The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.
[@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.

26
Dockerfile Normal file
View File

@ -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"]

View File

@ -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"> <p align="center">
<a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" /></a> <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 ```sh
# Clone the repository # 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 # Go to the project root
cd file-uploads-api cd file-uploads-api
@ -50,7 +50,13 @@ npm run dev
#### Services started #### 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 ## 💡 Contributing

11
docker-compose.yml Normal file
View File

@ -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'

18232
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,9 +1,12 @@
{ {
"name": "@thream/file-uploads-api", "name": "@thream/file-uploads-api",
"version": "1.0.0", "version": "1.1.6",
"description": "Thream's application programming interface to upload files.", "description": "Thream's application programming interface to upload files.",
"private": true, "private": true,
"type": "module", "type": "module",
"imports": {
"#src/*": "./build/*"
},
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/Thream/file-uploads-api" "url": "https://github.com/Thream/file-uploads-api"
@ -13,62 +16,66 @@
"npm": ">=8.0.0" "npm": ">=8.0.0"
}, },
"scripts": { "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", "build:dev": "swc ./src --out-dir ./build --watch",
"start": "node build/index.js", "build:typescript": "tsc",
"dev": "concurrently -k -n \"TypeScript,Node\" -p \"[{name}]\" -c \"blue,green\" \"npm run build:dev\" \"cross-env NODE_ENV=development nodemon build/index.js\"", "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:commit": "commitlint",
"lint:editorconfig": "editorconfig-checker", "lint:editorconfig": "editorconfig-checker",
"lint:markdown": "markdownlint \"**/*.md\" --dot --ignore-path \".gitignore\"", "lint:markdown": "markdownlint-cli2",
"lint:typescript": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"", "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
"lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"", "lint:prettier": "prettier . --check",
"lint:staged": "lint-staged", "lint:staged": "lint-staged",
"release": "semantic-release", "release": "semantic-release",
"postinstall": "husky install" "postinstall": "husky install"
}, },
"dependencies": { "dependencies": {
"@sinclair/typebox": "0.23.4", "@fastify/cors": "8.3.0",
"dotenv": "16.0.0", "@fastify/helmet": "11.0.0",
"fastify": "3.28.0", "@fastify/multipart": "7.6.0",
"fastify-cors": "6.0.3", "@fastify/rate-limit": "8.0.3",
"fastify-helmet": "7.0.1", "@fastify/sensible": "5.2.0",
"fastify-multipart": "5.3.1", "@fastify/static": "6.10.2",
"fastify-plugin": "3.0.1", "@fastify/swagger": "8.8.0",
"fastify-rate-limit": "5.8.0", "@fastify/swagger-ui": "1.9.2",
"fastify-sensible": "3.1.2", "@sinclair/typebox": "0.29.6",
"fastify-static": "4.6.1", "dotenv": "16.3.1",
"fastify-swagger": "5.1.0", "fastify": "4.20.0",
"fastify-plugin": "4.5.1",
"http-errors": "2.0.0", "http-errors": "2.0.0",
"read-pkg": "7.1.0" "read-pkg": "8.0.0"
}, },
"devDependencies": { "devDependencies": {
"@commitlint/cli": "16.2.3", "@commitlint/cli": "17.6.7",
"@commitlint/config-conventional": "16.2.1", "@commitlint/config-conventional": "17.6.7",
"@saithodev/semantic-release-backmerge": "2.1.2", "@saithodev/semantic-release-backmerge": "3.2.0",
"@semantic-release/git": "10.0.1", "@semantic-release/git": "10.0.1",
"@swc/cli": "0.1.57", "@swc/cli": "0.1.62",
"@swc/core": "1.2.164", "@swc/core": "1.3.70",
"@tsconfig/strictest": "2.0.1",
"@types/busboy": "1.5.0", "@types/busboy": "1.5.0",
"@types/http-errors": "1.8.2", "@types/http-errors": "2.0.1",
"@types/node": "17.0.23", "@types/node": "20.4.3",
"@typescript-eslint/eslint-plugin": "5.18.0", "@typescript-eslint/eslint-plugin": "6.1.0",
"concurrently": "7.1.0", "chokidar": "3.5.3",
"concurrently": "8.2.0",
"cross-env": "7.0.3", "cross-env": "7.0.3",
"editorconfig-checker": "4.0.2", "editorconfig-checker": "5.1.1",
"eslint": "8.12.0", "eslint": "8.45.0",
"eslint-config-conventions": "2.0.0", "eslint-config-conventions": "11.0.1",
"eslint-config-prettier": "8.5.0", "eslint-config-prettier": "8.8.0",
"eslint-plugin-import": "2.26.0", "eslint-plugin-import": "2.27.5",
"eslint-plugin-prettier": "4.0.0", "eslint-plugin-prettier": "5.0.0",
"eslint-plugin-promise": "6.0.0", "eslint-plugin-promise": "6.1.1",
"eslint-plugin-unicorn": "42.0.0", "eslint-plugin-unicorn": "48.0.0",
"husky": "7.0.4", "husky": "8.0.3",
"lint-staged": "12.3.7", "lint-staged": "13.2.3",
"markdownlint-cli": "0.31.1", "markdownlint-cli2": "0.8.1",
"nodemon": "2.0.15", "markdownlint-rule-relative-links": "2.1.0",
"prettier": "2.6.2", "prettier": "3.0.0",
"rimraf": "3.0.2", "rimraf": "5.0.1",
"semantic-release": "19.0.2", "semantic-release": "21.0.7",
"typescript": "4.6.3" "typescript": "5.1.6"
} }
} }

View File

@ -2,23 +2,29 @@ import { fileURLToPath } from 'node:url'
import dotenv from 'dotenv' import dotenv from 'dotenv'
import fastify from 'fastify' import fastify from 'fastify'
import fastifyCors from 'fastify-cors' import fastifyCors from '@fastify/cors'
import fastifySwagger from 'fastify-swagger' import fastifySwagger from '@fastify/swagger'
import fastifyHelmet from 'fastify-helmet' import fastifySwaggerUI from '@fastify/swagger-ui'
import fastifyRateLimit from 'fastify-rate-limit' import fastifyHelmet from '@fastify/helmet'
import fastifySensible from 'fastify-sensible' import fastifyRateLimit from '@fastify/rate-limit'
import fastifyStatic from 'fastify-static' import fastifySensible from '@fastify/sensible'
import fastifyStatic from '@fastify/static'
import { readPackage } from 'read-pkg'
import { services } from './services/index.js' import { services } from '#src/services/index.js'
import { swaggerOptions } from './tools/configurations/swaggerOptions.js' import { UPLOADS_URL } from '#src/tools/configurations.js'
import { UPLOADS_URL } from './tools/configurations/index.js'
dotenv.config() dotenv.config()
const packageJSON = await readPackage()
export const application = fastify({ export const application = fastify({
logger: process.env.NODE_ENV === 'development', logger: process.env['NODE_ENV'] === 'development',
ajv: { ajv: {
customOptions: { customOptions: {
format: 'full' strict: 'log',
keywords: ['kind', 'modifier'],
formats: {
full: true
}
} }
} }
}) })
@ -34,5 +40,28 @@ await application.register(fastifyStatic, {
root: fileURLToPath(UPLOADS_URL), root: fileURLToPath(UPLOADS_URL),
prefix: '/uploads/' 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) await application.register(services)

View File

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

View File

@ -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) => { export const services: FastifyPluginAsync = async (fastify) => {
await fastify.register(uploadsService) await fastify.register(uploadsService)

View File

@ -0,0 +1,48 @@
import type { FastifyPluginAsync, FastifySchema } from 'fastify'
import { Type } from '@sinclair/typebox'
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,
deleteUploadedFile
} from '#src/tools/utils/deleteUploadedFile.js'
export const deleteServiceSchema: FastifySchema = {
tags: ['guilds'] as string[],
security: [
{
apiKeyAuth: []
}
] as Array<{ [key: string]: [] }>,
params: deleteParameters,
response: {
200: Type.String(),
400: fastifyErrors[400],
404: fastifyErrors[404],
500: fastifyErrors[500]
}
} as const
export const deleteGuildsUploadsService: FastifyPluginAsync = async (
fastify
) => {
await fastify.register(verifyAPIKey)
await fastify.route<{
Params: DeleteParameters
}>({
method: 'DELETE',
url: '/uploads/guilds/:file',
schema: deleteServiceSchema,
handler: async (request, reply) => {
return await deleteUploadedFile({
fastify,
request,
reply,
folder: 'guilds'
})
}
})
}

View File

@ -1,9 +1,10 @@
import path from 'node:path' import path from 'node:path'
import { FastifyPluginAsync, FastifySchema } from 'fastify' import type { FastifyPluginAsync, FastifySchema } from 'fastify'
import { Static, Type } from '@sinclair/typebox' 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({ const parameters = Type.Object({
file: Type.String() file: Type.String()

View File

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

View File

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

View File

@ -0,0 +1,48 @@
import type { FastifyPluginAsync, FastifySchema } from 'fastify'
import { Type } from '@sinclair/typebox'
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,
deleteUploadedFile
} from '#src/tools/utils/deleteUploadedFile.js'
export const deleteServiceSchema: FastifySchema = {
tags: ['messages'] as string[],
security: [
{
apiKeyAuth: []
}
] as Array<{ [key: string]: [] }>,
params: deleteParameters,
response: {
200: Type.String(),
400: fastifyErrors[400],
404: fastifyErrors[404],
500: fastifyErrors[500]
}
} as const
export const deleteMessagesUploadsService: FastifyPluginAsync = async (
fastify
) => {
await fastify.register(verifyAPIKey)
await fastify.route<{
Params: DeleteParameters
}>({
method: 'DELETE',
url: '/uploads/messages/:file',
schema: deleteServiceSchema,
handler: async (request, reply) => {
return await deleteUploadedFile({
fastify,
request,
reply,
folder: 'messages'
})
}
})
}

View File

@ -1,9 +1,10 @@
import path from 'node:path' import path from 'node:path'
import { FastifyPluginAsync, FastifySchema } from 'fastify' import type { FastifyPluginAsync, FastifySchema } from 'fastify'
import { Static, Type } from '@sinclair/typebox' 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({ const parameters = Type.Object({
file: Type.String() file: Type.String()

View File

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

View File

@ -0,0 +1,48 @@
import type { FastifyPluginAsync, FastifySchema } from 'fastify'
import { Type } from '@sinclair/typebox'
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,
deleteUploadedFile
} from '#src/tools/utils/deleteUploadedFile.js'
export const deleteServiceSchema: FastifySchema = {
tags: ['users'] as string[],
security: [
{
apiKeyAuth: []
}
] as Array<{ [key: string]: [] }>,
params: deleteParameters,
response: {
200: Type.String(),
400: fastifyErrors[400],
404: fastifyErrors[404],
500: fastifyErrors[500]
}
} as const
export const deleteUsersUploadsService: FastifyPluginAsync = async (
fastify
) => {
await fastify.register(verifyAPIKey)
await fastify.route<{
Params: DeleteParameters
}>({
method: 'DELETE',
url: '/uploads/users/:file',
schema: deleteServiceSchema,
handler: async (request, reply) => {
return await deleteUploadedFile({
fastify,
request,
reply,
folder: 'users'
})
}
})
}

View File

@ -1,9 +1,10 @@
import path from 'node:path' import path from 'node:path'
import { FastifyPluginAsync, FastifySchema } from 'fastify' import type { FastifyPluginAsync, FastifySchema } from 'fastify'
import { Static, Type } from '@sinclair/typebox' 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({ const parameters = Type.Object({
file: Type.String() file: Type.String()

View File

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

View File

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

View File

@ -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
}

View File

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

View File

@ -0,0 +1,52 @@
import type { IncomingMessage, Server, ServerResponse } from 'node:http'
import { fileURLToPath } from 'node:url'
import fs from 'node:fs'
import type { Static } from '@sinclair/typebox'
import { Type } from '@sinclair/typebox'
import type {
FastifyBaseLogger,
FastifyInstance,
FastifyReply,
FastifyRequest,
FastifyTypeProviderDefault
} from 'fastify'
import { isExistingFile } from '#src/tools/utils/isExistingFile.js'
export const deleteParameters = Type.Object({
file: Type.String()
})
export type DeleteParameters = Static<typeof deleteParameters>
export interface DeleteUploadedFileOptions {
folder: 'guilds' | 'messages' | 'users'
fastify: FastifyInstance<
Server<typeof IncomingMessage, typeof ServerResponse>,
IncomingMessage,
ServerResponse<IncomingMessage>,
FastifyBaseLogger,
FastifyTypeProviderDefault
>
request: FastifyRequest<{ Params: DeleteParameters }>
reply: FastifyReply
}
export const deleteUploadedFile = async (
options: DeleteUploadedFileOptions
): Promise<string> => {
const { request, fastify, reply, folder } = options
if (request.apiKey == null) {
throw fastify.httpErrors.forbidden()
}
const { file } = request.params
const fileURL = new URL(`../../../uploads/${folder}/${file}`, import.meta.url)
const filePath = fileURLToPath(fileURL)
if (!(await isExistingFile(filePath))) {
throw fastify.httpErrors.notFound('File does not exist')
}
await fs.promises.rm(filePath, { force: true })
reply.statusCode = 200
return file
}

View File

@ -0,0 +1,10 @@
import fs from 'node:fs'
export const isExistingFile = async (path: string): Promise<boolean> => {
try {
await fs.promises.access(path, fs.constants.F_OK)
return true
} catch {
return false
}
}

View File

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

View File

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