Compare commits

...

31 Commits

Author SHA1 Message Date
semantic-release-bot
a6350306fb
chore(release): 1.1.8 [skip ci] 2023-12-28 04:06:14 +00:00
503365b0ef
chore: update semantic-release tooling 2023-12-28 05:05:32 +01:00
e692464bb5
fix: deprecation notice 2023-12-28 05:00:39 +01:00
d638d7b3d4
chore: better Prettier config for easier reviews 2023-10-23 23:41:21 +02:00
semantic-release-bot
aaf4e2c4c6
chore(release): 1.1.7 [skip ci] 2023-09-18 20:32:25 +00:00
dc2ca44311
fix: update dependencies to latest 2023-09-18 22:28:52 +02:00
92b184630b
build(deps): update latest 2023-08-24 22:09:45 +02:00
5da567de9d
chore: rename docker-compose.yml to compose.yaml
Ref: https://docs.docker.com/compose/compose-file/03-compose-file/
2023-07-28 12:24:57 +02:00
semantic-release-bot
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
semantic-release-bot
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
Divlo
8b62aa726a
docs: usage of 127.0.0.1 instead of localhost 2023-05-13 22:49:32 +02:00
semantic-release-bot
9445303630
chore(release): 1.1.4 [skip ci] 2023-05-13 17:58:09 +00:00
Divlo
621ebfb611
fix: release new version 2023-05-13 19:57:15 +02:00
Divlo
d08bd2c59c
chore: fix release issues 2023-05-13 19:52:44 +02:00
Divlo
b4f7221fe0
build(deps): update latest 2023-05-13 19:47:36 +02:00
semantic-release-bot
338aeca2e7
chore(release): 1.1.3 [skip ci] 2023-04-02 21:42:57 +00:00
Divlo
568d4a95a3
ci: update Node.js to v18 2023-04-02 23:41:53 +02:00
Divlo
4bfe1e3ce6
fix: update dependencies to latest 2023-04-02 23:37:44 +02:00
semantic-release-bot
8a3bbcca18
chore(release): 1.1.2 [skip ci] 2023-01-11 00:09:39 +00:00
Divlo
79ebeaced3
fix: regression introduced in v1.1.1 2023-01-11 01:08:40 +01:00
semantic-release-bot
c34741d197
chore(release): 1.1.1 [skip ci] 2023-01-10 23:27:12 +00:00
Divlo
c4e9a2316e
fix: update dependencies to latest 2023-01-11 00:24:19 +01:00
semantic-release-bot
c583d987d3
chore(release): 1.1.0 [skip ci] 2022-06-29 03:23:28 +00:00
Divlo
7ff8d8e347
feat: add DELETE services to delete files uploaded 2022-06-29 05:19:03 +02:00
Divlo
262c1d76c2
build(deps): update latest 2022-06-29 05:00:35 +02:00
Divlo
9109842248
chore: configure correctly semantic-release 2022-04-08 21:43:17 +02:00
49 changed files with 7600 additions and 12798 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_URL=http://localhost:8000
HOST=0.0.0.0

View File

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

View File

@ -1,8 +1,8 @@
---
name: '🐛 Bug Report'
about: 'Report an unexpected problem or unintended behavior.'
title: '[Bug]'
labels: 'bug'
name: "🐛 Bug Report"
about: "Report an unexpected problem or unintended behavior."
title: "[Bug]"
labels: "bug"
---
<!--

View File

@ -1,8 +1,8 @@
---
name: '📜 Documentation'
about: 'Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).'
title: '[Documentation]'
labels: 'documentation'
name: "📜 Documentation"
about: "Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...)."
title: "[Documentation]"
labels: "documentation"
---
<!-- Please make sure your issue has not already been fixed. -->

View File

@ -1,8 +1,8 @@
---
name: '✨ Feature Request'
about: 'Suggest a new feature idea.'
title: '[Feature]'
labels: 'feature request'
name: "✨ Feature Request"
about: "Suggest a new feature idea."
title: "[Feature]"
labels: "feature request"
---
<!-- Please make sure your issue has not already been fixed. -->

View File

@ -1,8 +1,8 @@
---
name: '🔧 Improvement'
about: 'Improve structure/format/performance/refactor/tests of the code.'
title: '[Improvement]'
labels: 'improvement'
name: "🔧 Improvement"
about: "Improve structure/format/performance/refactor/tests of the code."
title: "[Improvement]"
labels: "improvement"
---
<!-- Please make sure your issue has not already been fixed. -->

View File

@ -1,8 +1,8 @@
---
name: '🙋 Question'
about: 'Further information is requested.'
title: '[Question]'
labels: 'question'
name: "🙋 Question"
about: "Further information is requested."
title: "[Question]"
labels: "question"
---
### Question

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. -->
## What changes this PR introduce?
# What changes this PR introduce?
## List any relevant issue numbers

View File

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

View File

@ -1,4 +1,4 @@
name: 'Lint'
name: "Lint"
on:
push:
@ -8,35 +8,35 @@ on:
jobs:
lint:
runs-on: 'ubuntu-latest'
runs-on: "ubuntu-latest"
steps:
- uses: 'actions/checkout@v3.0.0'
- uses: "actions/checkout@v4.0.0"
- name: 'Use Node.js'
uses: 'actions/setup-node@v3.0.0'
- name: "Setup Node.js"
uses: "actions/setup-node@v3.8.1"
with:
node-version: '16.x'
cache: 'npm'
node-version: "20.x"
cache: "npm"
- name: 'Install'
run: 'npm install'
- name: "Install dependencies"
run: "npm clean-install"
- name: 'lint:commit'
- name: "lint:commit"
run: 'npm run lint:commit -- --to "${{ github.sha }}"'
- name: 'lint:editorconfig'
run: 'npm run lint:editorconfig'
- name: "lint:editorconfig"
run: "npm run lint:editorconfig"
- name: 'lint:markdown'
run: 'npm run lint:markdown'
- 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'
- name: "lint:prettier"
run: "npm run lint:prettier"
- name: 'lint:dotenv'
uses: 'dotenv-linter/action-dotenv-linter@v2'
- name: "lint:dotenv"
uses: "dotenv-linter/action-dotenv-linter@v2.18.0"
with:
github_token: ${{ secrets.github_token }}

View File

@ -1,4 +1,4 @@
name: 'Release'
name: "Release"
on:
push:
@ -6,34 +6,36 @@ on:
jobs:
release:
runs-on: 'ubuntu-latest'
runs-on: "ubuntu-latest"
steps:
- uses: 'actions/checkout@v3.0.0'
- uses: "actions/checkout@v4.0.0"
with:
fetch-depth: 0
persist-credentials: false
- name: 'Import GPG key'
uses: 'crazy-max/ghaction-import-gpg@v3.2.0'
- name: "Import GPG key"
uses: "crazy-max/ghaction-import-gpg@v6.0.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.8.1"
with:
node-version: '16.x'
cache: 'npm'
node-version: "20.x"
cache: "npm"
- name: 'Install'
run: 'npm install'
- name: "Install dependencies"
run: "npm clean-install"
- name: 'Build'
run: 'npm run build'
- name: "Build"
run: "npm run build"
- name: 'Release'
run: 'npm run release'
- run: "npm run build:typescript"
- name: "Release"
run: "npm run release"
env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
GIT_COMMITTER_NAME: ${{ secrets.GIT_NAME }}

View File

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

View File

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

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

@ -1,6 +1,3 @@
{
"singleQuote": true,
"jsxSingleQuote": true,
"semi": false,
"trailingComma": "none"
"semi": false
}

View File

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

15
.swcrc
View File

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

View File

@ -5,7 +5,7 @@
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll": true
"source.fixAll": "explicit"
},
"eslint.options": { "ignorePath": ".gitignore" }
}

View File

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

View File

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

26
Dockerfile Normal file
View File

@ -0,0 +1,26 @@
FROM node:20.9.0 AS builder-dependencies
WORKDIR /usr/src/application
COPY ./package*.json ./
RUN npm clean-install
FROM node:20.9.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.9.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-debian12: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,8 @@
<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">
<strong>⚠️ This project is not maintained anymore, you can still use the code as you wish and fork it to maintain it yourself.</strong>
</p>
<p align="center">
<a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" /></a>
@ -27,7 +31,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 +54,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

11
compose.yaml 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"

19305
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",
"version": "1.0.0",
"version": "1.1.8",
"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.4",
"dotenv": "16.0.0",
"fastify": "3.28.0",
"fastify-cors": "6.0.3",
"fastify-helmet": "7.0.1",
"fastify-multipart": "5.3.1",
"fastify-plugin": "3.0.1",
"fastify-rate-limit": "5.8.0",
"fastify-sensible": "3.1.2",
"fastify-static": "4.6.1",
"fastify-swagger": "5.1.0",
"@fastify/cors": "8.4.0",
"@fastify/helmet": "11.1.1",
"@fastify/multipart": "8.0.0",
"@fastify/rate-limit": "8.0.3",
"@fastify/sensible": "5.5.0",
"@fastify/static": "6.11.2",
"@fastify/swagger": "8.12.0",
"@fastify/swagger-ui": "1.10.1",
"@sinclair/typebox": "0.31.18",
"dotenv": "16.3.1",
"fastify": "4.24.3",
"fastify-plugin": "4.5.1",
"http-errors": "2.0.0",
"read-pkg": "7.1.0"
"read-pkg": "8.1.0"
},
"devDependencies": {
"@commitlint/cli": "16.2.3",
"@commitlint/config-conventional": "16.2.1",
"@saithodev/semantic-release-backmerge": "2.1.2",
"@commitlint/cli": "18.4.3",
"@commitlint/config-conventional": "18.4.3",
"@saithodev/semantic-release-backmerge": "4.0.1",
"@semantic-release/git": "10.0.1",
"@swc/cli": "0.1.57",
"@swc/core": "1.2.164",
"@types/busboy": "1.5.0",
"@types/http-errors": "1.8.2",
"@types/node": "17.0.23",
"@typescript-eslint/eslint-plugin": "5.18.0",
"concurrently": "7.1.0",
"@swc/cli": "0.1.62",
"@swc/core": "1.3.94",
"@tsconfig/strictest": "2.0.2",
"@types/busboy": "1.5.2",
"@types/http-errors": "2.0.3",
"@types/node": "20.8.7",
"@typescript-eslint/eslint-plugin": "6.9.0",
"chokidar": "3.5.3",
"concurrently": "8.2.2",
"cross-env": "7.0.3",
"editorconfig-checker": "4.0.2",
"eslint": "8.12.0",
"eslint-config-conventions": "2.0.0",
"eslint-config-prettier": "8.5.0",
"eslint-plugin-import": "2.26.0",
"eslint-plugin-prettier": "4.0.0",
"eslint-plugin-promise": "6.0.0",
"eslint-plugin-unicorn": "42.0.0",
"husky": "7.0.4",
"lint-staged": "12.3.7",
"markdownlint-cli": "0.31.1",
"nodemon": "2.0.15",
"prettier": "2.6.2",
"rimraf": "3.0.2",
"semantic-release": "19.0.2",
"typescript": "4.6.3"
"editorconfig-checker": "5.1.1",
"eslint": "8.52.0",
"eslint-config-conventions": "12.0.0",
"eslint-config-prettier": "9.0.0",
"eslint-plugin-import": "2.29.0",
"eslint-plugin-prettier": "5.0.1",
"eslint-plugin-promise": "6.1.1",
"eslint-plugin-unicorn": "48.0.1",
"husky": "8.0.3",
"lint-staged": "15.0.2",
"markdownlint-cli2": "0.10.0",
"markdownlint-rule-relative-links": "2.1.0",
"prettier": "3.0.3",
"rimraf": "5.0.5",
"semantic-release": "22.0.12",
"typescript": "5.2.2"
}
}

View File

@ -1,26 +1,32 @@
import { fileURLToPath } from 'node:url'
import { fileURLToPath } from "node:url"
import dotenv from 'dotenv'
import fastify from 'fastify'
import fastifyCors from 'fastify-cors'
import fastifySwagger from 'fastify-swagger'
import fastifyHelmet from 'fastify-helmet'
import fastifyRateLimit from 'fastify-rate-limit'
import fastifySensible from 'fastify-sensible'
import fastifyStatic from 'fastify-static'
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: {
format: 'full'
}
}
strict: "log",
keywords: ["kind", "modifier"],
formats: {
full: true,
},
},
},
})
await application.register(fastifyCors)
@ -28,11 +34,34 @@ await application.register(fastifySensible)
await application.register(fastifyHelmet)
await application.register(fastifyRateLimit, {
max: 200,
timeWindow: '1 minute'
timeWindow: "1 minute",
})
await application.register(fastifyStatic, {
root: fileURLToPath(UPLOADS_URL),
prefix: '/uploads/'
prefix: "/uploads/",
})
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(fastifySwagger, swaggerOptions)
await application.register(services)

View File

@ -1,5 +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, HOST)
console.log('\u001B[36m%s\u001B[0m', `🚀 Server listening at ${address}`)
const address = await application.listen({
port: PORT,
host: HOST,
})
console.log(`Server listening at ${address}`)

View File

@ -1,36 +1,36 @@
import { Type } from '@sinclair/typebox'
import { Type } from "@sinclair/typebox"
export const fastifyErrorsSchema = {
400: {
statusCode: Type.Literal(400),
error: Type.Literal('Bad Request'),
message: Type.String()
error: Type.Literal("Bad Request"),
message: Type.String(),
},
401: {
statusCode: Type.Literal(401),
error: Type.Literal('Unauthorized'),
message: Type.Literal('Unauthorized')
error: Type.Literal("Unauthorized"),
message: Type.Literal("Unauthorized"),
},
403: {
statusCode: Type.Literal(403),
error: Type.Literal('Forbidden'),
message: Type.Literal('Forbidden')
error: Type.Literal("Forbidden"),
message: Type.Literal("Forbidden"),
},
404: {
statusCode: Type.Literal(404),
error: Type.Literal('Not Found'),
message: Type.Literal('Not Found')
error: Type.Literal("Not Found"),
message: Type.Literal("Not Found"),
},
431: {
statusCode: Type.Literal(431),
error: Type.Literal('Request Header Fields Too Large'),
message: Type.String()
error: Type.Literal("Request Header Fields Too Large"),
message: Type.String(),
},
500: {
statusCode: Type.Literal(500),
error: Type.Literal('Internal Server Error'),
message: Type.Literal('Something went wrong')
}
error: Type.Literal("Internal Server Error"),
message: Type.Literal("Something went wrong"),
},
}
export const fastifyErrors = {
@ -39,5 +39,5 @@ export const fastifyErrors = {
403: Type.Object(fastifyErrorsSchema[403]),
404: Type.Object(fastifyErrorsSchema[404]),
431: Type.Object(fastifyErrorsSchema[431]),
500: Type.Object(fastifyErrorsSchema[500])
500: Type.Object(fastifyErrorsSchema[500]),
}

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) => {
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,40 +1,41 @@
import path from 'node:path'
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()
file: Type.String(),
})
type Parameters = Static<typeof parameters>
export const getServiceSchema: FastifySchema = {
tags: ['guilds'] as string[],
tags: ["guilds"] as string[],
params: parameters,
response: {
200: {
type: 'string',
format: 'binary'
type: "string",
format: "binary",
},
400: fastifyErrors[400],
404: fastifyErrors[404],
500: fastifyErrors[500]
}
500: fastifyErrors[500],
},
} as const
export const getGuildsUploadsService: FastifyPluginAsync = async (fastify) => {
await fastify.route<{
Params: Parameters
}>({
method: 'GET',
url: '/uploads/guilds/:file',
method: "GET",
url: "/uploads/guilds/:file",
schema: getServiceSchema,
handler: async (request, reply) => {
const { file } = request.params
return await reply.sendFile(path.join('guilds', file))
}
return await reply.sendFile(path.join("guilds", file))
},
})
}

View File

@ -1,44 +1,44 @@
import { Type } from '@sinclair/typebox'
import { FastifyPluginAsync, FastifySchema } from 'fastify'
import fastifyMultipart from 'fastify-multipart'
import { Type } from "@sinclair/typebox"
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'
SUPPORTED_IMAGE_MIMETYPE,
} from "#src/tools/configurations.js"
import verifyAPIKey from "#src/tools/plugins/verifyAPIKey.js"
const postServiceSchema: FastifySchema = {
description: 'Uploads guild icon',
tags: ['guilds'] as string[],
description: "Uploads guild icon",
tags: ["guilds"] as string[],
security: [
{
apiKeyAuth: []
}
apiKeyAuth: [],
},
] as Array<{ [key: string]: [] }>,
consumes: ['multipart/form-data'] as string[],
produces: ['application/json'] as string[],
consumes: ["multipart/form-data"] as string[],
produces: ["application/json"] as string[],
response: {
201: Type.String(),
400: fastifyErrors[400],
401: fastifyErrors[401],
403: fastifyErrors[403],
431: fastifyErrors[431],
500: fastifyErrors[500]
}
500: fastifyErrors[500],
},
} as const
export const postGuildsUploadsIconService: FastifyPluginAsync = async (
fastify
fastify,
) => {
await fastify.register(fastifyMultipart)
await fastify.register(verifyAPIKey)
fastify.route({
method: 'POST',
url: '/uploads/guilds',
method: "POST",
url: "/uploads/guilds",
schema: postServiceSchema,
handler: async (request, reply) => {
if (request.apiKey == null) {
@ -47,12 +47,12 @@ export const postGuildsUploadsIconService: FastifyPluginAsync = async (
const file = await uploadFile({
fastify,
request,
folderInUploadsFolder: 'guilds',
folderInUploadsFolder: "guilds",
maximumFileSize: MAXIMUM_IMAGE_SIZE,
supportedFileMimetype: SUPPORTED_IMAGE_MIMETYPE
supportedFileMimetype: SUPPORTED_IMAGE_MIMETYPE,
})
reply.statusCode = 201
return file.pathToStoreInDatabase
}
},
})
}

View File

@ -1,19 +1,25 @@
import { FastifyPluginAsync } from 'fastify'
import type { FastifyPluginAsync } from "fastify"
import { getGuildsUploadsService } from './guilds/get.js'
import { postGuildsUploadsIconService } from './guilds/post.js'
import { getMessagesUploadsService } from './messages/get.js'
import { postMessagesUploadsService } from './messages/post.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)
await fastify.register(getGuildsUploadsService)
await fastify.register(postGuildsUploadsIconService)
await fastify.register(deleteMessagesUploadsService)
await fastify.register(getMessagesUploadsService)
await fastify.register(postMessagesUploadsService)
await fastify.register(deleteUsersUploadsService)
await fastify.register(getUsersUploadsService)
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,42 +1,43 @@
import path from 'node:path'
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()
file: Type.String(),
})
type Parameters = Static<typeof parameters>
export const getServiceSchema: FastifySchema = {
tags: ['messages'] as string[],
tags: ["messages"] as string[],
params: parameters,
response: {
200: {
type: 'string',
format: 'binary'
type: "string",
format: "binary",
},
400: fastifyErrors[400],
404: fastifyErrors[404],
500: fastifyErrors[500]
}
500: fastifyErrors[500],
},
} as const
export const getMessagesUploadsService: FastifyPluginAsync = async (
fastify
fastify,
) => {
fastify.route<{
Params: Parameters
}>({
method: 'GET',
url: '/uploads/messages/:file',
method: "GET",
url: "/uploads/messages/:file",
schema: getServiceSchema,
handler: async (request, reply) => {
const { file } = request.params
return await reply.sendFile(path.join('messages', file))
}
return await reply.sendFile(path.join("messages", file))
},
})
}

View File

@ -1,41 +1,41 @@
import { Type } from '@sinclair/typebox'
import { FastifyPluginAsync, FastifySchema } from 'fastify'
import fastifyMultipart from 'fastify-multipart'
import { Type } from "@sinclair/typebox"
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',
tags: ['messages'] as string[],
description: "Uploads message file",
tags: ["messages"] as string[],
security: [
{
apiKeyAuth: []
}
apiKeyAuth: [],
},
] as Array<{ [key: string]: [] }>,
consumes: ['multipart/form-data'] as string[],
produces: ['application/json'] as string[],
consumes: ["multipart/form-data"] as string[],
produces: ["application/json"] as string[],
response: {
201: Type.String(),
400: fastifyErrors[400],
401: fastifyErrors[401],
403: fastifyErrors[403],
431: fastifyErrors[431],
500: fastifyErrors[500]
}
500: fastifyErrors[500],
},
} as const
export const postMessagesUploadsService: FastifyPluginAsync = async (
fastify
fastify,
) => {
await fastify.register(fastifyMultipart)
await fastify.register(verifyAPIKey)
fastify.route({
method: 'POST',
url: '/uploads/messages',
method: "POST",
url: "/uploads/messages",
schema: postServiceSchema,
handler: async (request, reply) => {
if (request.apiKey == null) {
@ -44,11 +44,11 @@ export const postMessagesUploadsService: FastifyPluginAsync = async (
const file = await uploadFile({
fastify,
request,
folderInUploadsFolder: 'messages',
maximumFileSize: MAXIMUM_IMAGE_SIZE
folderInUploadsFolder: "messages",
maximumFileSize: MAXIMUM_IMAGE_SIZE,
})
reply.statusCode = 201
return file.pathToStoreInDatabase
}
},
})
}

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,40 +1,41 @@
import path from 'node:path'
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()
file: Type.String(),
})
type Parameters = Static<typeof parameters>
export const getServiceSchema: FastifySchema = {
tags: ['users'] as string[],
tags: ["users"] as string[],
params: parameters,
response: {
200: {
type: 'string',
format: 'binary'
type: "string",
format: "binary",
},
400: fastifyErrors[400],
404: fastifyErrors[404],
500: fastifyErrors[500]
}
500: fastifyErrors[500],
},
} as const
export const getUsersUploadsService: FastifyPluginAsync = async (fastify) => {
await fastify.route<{
Params: Parameters
}>({
method: 'GET',
url: '/uploads/users/:file',
method: "GET",
url: "/uploads/users/:file",
schema: getServiceSchema,
handler: async (request, reply) => {
const { file } = request.params
return await reply.sendFile(path.join('users', file))
}
return await reply.sendFile(path.join("users", file))
},
})
}

View File

@ -1,44 +1,44 @@
import { Type } from '@sinclair/typebox'
import { FastifyPluginAsync, FastifySchema } from 'fastify'
import fastifyMultipart from 'fastify-multipart'
import { Type } from "@sinclair/typebox"
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'
SUPPORTED_IMAGE_MIMETYPE,
} from "#src/tools/configurations.js"
import verifyAPIKey from "#src/tools/plugins/verifyAPIKey.js"
const postServiceSchema: FastifySchema = {
description: 'Uploads user logo',
tags: ['users'] as string[],
description: "Uploads user logo",
tags: ["users"] as string[],
security: [
{
apiKeyAuth: []
}
apiKeyAuth: [],
},
] as Array<{ [key: string]: [] }>,
consumes: ['multipart/form-data'] as string[],
produces: ['application/json'] as string[],
consumes: ["multipart/form-data"] as string[],
produces: ["application/json"] as string[],
response: {
201: Type.String(),
400: fastifyErrors[400],
401: fastifyErrors[401],
403: fastifyErrors[403],
431: fastifyErrors[431],
500: fastifyErrors[500]
}
500: fastifyErrors[500],
},
} as const
export const postUsersUploadsLogoService: FastifyPluginAsync = async (
fastify
fastify,
) => {
await fastify.register(fastifyMultipart)
await fastify.register(verifyAPIKey)
fastify.route({
method: 'POST',
url: '/uploads/users',
method: "POST",
url: "/uploads/users",
schema: postServiceSchema,
handler: async (request, reply) => {
if (request.apiKey == null) {
@ -47,12 +47,12 @@ export const postUsersUploadsLogoService: FastifyPluginAsync = async (
const file = await uploadFile({
fastify,
request,
folderInUploadsFolder: 'users',
folderInUploadsFolder: "users",
maximumFileSize: MAXIMUM_IMAGE_SIZE,
supportedFileMimetype: SUPPORTED_IMAGE_MIMETYPE
supportedFileMimetype: SUPPORTED_IMAGE_MIMETYPE,
})
reply.statusCode = 201
return file.pathToStoreInDatabase
}
},
})
}

View File

@ -0,0 +1,27 @@
import { URL } from "node:url"
import dotenv from "dotenv"
dotenv.config()
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 ROOT_URL = new URL("../", SRC_URL)
export const UPLOADS_URL = new URL("./uploads/", ROOT_URL)
export const SUPPORTED_IMAGE_MIMETYPE = [
"image/png",
"image/jpg",
"image/jpeg",
"image/gif",
]
/** in megabytes */
export const MAXIMUM_IMAGE_SIZE = 10
/** in megabytes */
export const MAXIMUM_FILE_SIZE = 100

View File

@ -1,27 +0,0 @@
import { URL } from 'node:url'
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 SRC_URL = new URL('../../', import.meta.url)
export const ROOT_URL = new URL('../', SRC_URL)
export const UPLOADS_URL = new URL('./uploads/', ROOT_URL)
export const SUPPORTED_IMAGE_MIMETYPE = [
'image/png',
'image/jpg',
'image/jpeg',
'image/gif'
]
/** in megabytes */
export const MAXIMUM_IMAGE_SIZE = 10
/** in megabytes */
export const MAXIMUM_FILE_SIZE = 100

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,11 +1,11 @@
import fastifyPlugin from 'fastify-plugin'
import httpErrors from 'http-errors'
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
declare module 'fastify' {
declare module "fastify" {
export interface FastifyRequest {
apiKey?: string
}
@ -13,10 +13,10 @@ declare module 'fastify' {
export default fastifyPlugin(
async (fastify) => {
await fastify.decorateRequest('apiKey', null)
await fastify.addHook('onRequest', async (request) => {
const apiKey = request.headers['x-api-key']
if (apiKey == null || typeof apiKey !== 'string') {
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()
}
if (apiKey !== API_KEY) {
@ -25,5 +25,5 @@ export default fastifyPlugin(
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

@ -1,14 +1,14 @@
import fs from 'node:fs'
import { URL } from 'node:url'
import { randomUUID } from 'node:crypto'
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'
folderInUploadsFolder: "guilds" | "messages" | "users"
request: FastifyRequest
fastify: FastifyInstance
@ -24,42 +24,46 @@ export interface UploadFileResult {
}
export const uploadFile = async (
options: UploadFileOptions
options: UploadFileOptions,
): Promise<UploadFileResult> => {
const {
fastify,
request,
folderInUploadsFolder,
maximumFileSize,
supportedFileMimetype
supportedFileMimetype,
} = options
let files: Multipart[] = []
let files: SavedMultipartFile[] = []
try {
files = await request.saveRequestFiles({
limits: {
files: 1,
fileSize: maximumFileSize * 1024 * 1024
}
fileSize: maximumFileSize * 1024 * 1024,
},
})
} catch (error) {
console.error(error)
throw fastify.httpErrors.requestHeaderFieldsTooLarge(
`File should be less than ${maximumFileSize}mb.`
`File should be less than ${maximumFileSize}mb.`,
)
}
if (files.length !== 1) {
throw fastify.httpErrors.badRequest('You must upload at most one file.')
}
const file = files[0]
if (files.length !== 1 || file == null) {
throw fastify.httpErrors.badRequest("You must upload at most one file.")
}
if (
supportedFileMimetype != null &&
!supportedFileMimetype.includes(file.mimetype)
) {
throw fastify.httpErrors.badRequest(
`The file must have a valid type (${supportedFileMimetype.join(', ')}).`
`The file must have a valid type (${supportedFileMimetype.join(", ")}).`,
)
}
const splitedMimetype = file.mimetype.split('/')
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}`

View File

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