Compare commits
21 Commits
Author | SHA1 | Date | |
---|---|---|---|
d83092bd34 | |||
03008a5246
|
|||
4a4eaac3cd
|
|||
eaafa40125
|
|||
72d560363e
|
|||
8b62aa726a | |||
9445303630 | |||
621ebfb611 | |||
d08bd2c59c | |||
b4f7221fe0 | |||
338aeca2e7 | |||
568d4a95a3 | |||
4bfe1e3ce6 | |||
8a3bbcca18 | |||
79ebeaced3 | |||
c34741d197 | |||
c4e9a2316e | |||
c583d987d3 | |||
7ff8d8e347 | |||
262c1d76c2 | |||
9109842248 |
@ -10,7 +10,6 @@
|
||||
"rules": {
|
||||
"prettier/prettier": "error",
|
||||
"import/extensions": ["error", "always"],
|
||||
"unicorn/prevent-abbreviations": "error",
|
||||
"unicorn/prefer-node-protocol": "error"
|
||||
"unicorn/prevent-abbreviations": "error"
|
||||
}
|
||||
}
|
||||
|
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -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
|
||||
|
||||
|
14
.github/workflows/build.yml
vendored
14
.github/workflows/build.yml
vendored
@ -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: '18.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'
|
||||
|
16
.github/workflows/lint.yml
vendored
16
.github/workflows/lint.yml
vendored
@ -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: '18.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'
|
||||
|
22
.github/workflows/release.yml
vendored
22
.github/workflows/release.yml
vendored
@ -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: '18.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:
|
||||
|
@ -3,3 +3,4 @@
|
||||
|
||||
npm run lint:staged
|
||||
npm run build
|
||||
npm run build:typescript
|
||||
|
@ -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
11
.markdownlint-cli2.jsonc
Normal 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"]
|
||||
}
|
@ -1,6 +0,0 @@
|
||||
{
|
||||
"default": true,
|
||||
"MD013": false,
|
||||
"MD033": false,
|
||||
"MD041": false
|
||||
}
|
@ -30,6 +30,7 @@
|
||||
[
|
||||
"@saithodev/semantic-release-backmerge",
|
||||
{
|
||||
"branches": [{ "from": "master", "to": "develop" }],
|
||||
"backmergeStrategy": "merge"
|
||||
}
|
||||
]
|
||||
|
1
.swcrc
1
.swcrc
@ -1,4 +1,5 @@
|
||||
{
|
||||
"sourceMaps": true,
|
||||
"jsc": {
|
||||
"parser": {
|
||||
"syntax": "typescript",
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
@ -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,7 @@ npm run dev
|
||||
|
||||
#### Services started
|
||||
|
||||
- API : `http://localhost:8000`
|
||||
- `file-uploads-api`: <http://127.0.0.1:8000>
|
||||
|
||||
## 💡 Contributing
|
||||
|
||||
|
17706
package-lock.json
generated
17706
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
91
package.json
91
package.json
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@thream/file-uploads-api",
|
||||
"version": "1.0.0",
|
||||
"version": "1.1.5",
|
||||
"description": "Thream's application programming interface to upload files.",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
@ -13,62 +13,65 @@
|
||||
"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 . --ignore-path .gitignore",
|
||||
"lint:prettier": "prettier . --check --ignore-path .gitignore",
|
||||
"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.3.0",
|
||||
"@fastify/helmet": "11.0.0",
|
||||
"@fastify/multipart": "7.7.0",
|
||||
"@fastify/rate-limit": "8.0.1",
|
||||
"@fastify/sensible": "5.2.0",
|
||||
"@fastify/static": "6.10.2",
|
||||
"@fastify/swagger": "8.6.0",
|
||||
"@fastify/swagger-ui": "1.9.2",
|
||||
"@sinclair/typebox": "0.29.0",
|
||||
"dotenv": "16.3.1",
|
||||
"fastify": "4.19.1",
|
||||
"fastify-plugin": "4.5.0",
|
||||
"http-errors": "2.0.0",
|
||||
"read-pkg": "7.1.0"
|
||||
"read-pkg": "8.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@commitlint/cli": "16.2.3",
|
||||
"@commitlint/config-conventional": "16.2.1",
|
||||
"@saithodev/semantic-release-backmerge": "2.1.2",
|
||||
"@commitlint/cli": "17.6.6",
|
||||
"@commitlint/config-conventional": "17.6.6",
|
||||
"@saithodev/semantic-release-backmerge": "3.2.0",
|
||||
"@semantic-release/git": "10.0.1",
|
||||
"@swc/cli": "0.1.57",
|
||||
"@swc/core": "1.2.164",
|
||||
"@swc/cli": "0.1.62",
|
||||
"@swc/core": "1.3.67",
|
||||
"@tsconfig/strictest": "2.0.1",
|
||||
"@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",
|
||||
"@types/http-errors": "2.0.1",
|
||||
"@types/node": "20.3.3",
|
||||
"@typescript-eslint/eslint-plugin": "5.60.1",
|
||||
"concurrently": "8.2.0",
|
||||
"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.44.0",
|
||||
"eslint-config-conventions": "10.0.0",
|
||||
"eslint-config-prettier": "8.8.0",
|
||||
"eslint-plugin-import": "2.27.5",
|
||||
"eslint-plugin-prettier": "4.2.1",
|
||||
"eslint-plugin-promise": "6.1.1",
|
||||
"eslint-plugin-unicorn": "47.0.0",
|
||||
"husky": "8.0.3",
|
||||
"lint-staged": "13.2.3",
|
||||
"markdownlint-cli2": "0.8.1",
|
||||
"markdownlint-rule-relative-links": "2.1.0",
|
||||
"prettier": "2.8.8",
|
||||
"rimraf": "5.0.1",
|
||||
"semantic-release": "21.0.6",
|
||||
"typescript": "5.0.4"
|
||||
}
|
||||
}
|
||||
|
@ -2,23 +2,29 @@ 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 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 { UPLOADS_URL } from './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
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
@ -34,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)
|
||||
|
@ -1,5 +1,8 @@
|
||||
import { application } from './application.js'
|
||||
import { HOST, PORT } from './tools/configurations/index.js'
|
||||
import { HOST, PORT } from './tools/configurations.js'
|
||||
|
||||
const address = await application.listen(PORT, HOST)
|
||||
const address = await application.listen({
|
||||
port: PORT,
|
||||
host: HOST
|
||||
})
|
||||
console.log('\u001B[36m%s\u001B[0m', `🚀 Server listening at ${address}`)
|
||||
|
@ -1,4 +1,4 @@
|
||||
import { FastifyPluginAsync } from 'fastify'
|
||||
import type { FastifyPluginAsync } from 'fastify'
|
||||
|
||||
import { uploadsService } from './uploads/index.js'
|
||||
|
||||
|
48
src/services/uploads/guilds/delete.ts
Normal file
48
src/services/uploads/guilds/delete.ts
Normal file
@ -0,0 +1,48 @@
|
||||
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 type { DeleteParameters } from '../../../tools/utils/deleteUploadedFile.js'
|
||||
import {
|
||||
deleteParameters,
|
||||
deleteUploadedFile
|
||||
} from '../../../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'
|
||||
})
|
||||
}
|
||||
})
|
||||
}
|
@ -1,7 +1,8 @@
|
||||
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'
|
||||
|
||||
|
@ -1,13 +1,13 @@
|
||||
import { Type } from '@sinclair/typebox'
|
||||
import { FastifyPluginAsync, FastifySchema } from 'fastify'
|
||||
import fastifyMultipart from 'fastify-multipart'
|
||||
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,
|
||||
SUPPORTED_IMAGE_MIMETYPE
|
||||
} from '../../../tools/configurations/index.js'
|
||||
} from '../../../tools/configurations.js'
|
||||
import verifyAPIKey from '../../../tools/plugins/verifyAPIKey.js'
|
||||
|
||||
const postServiceSchema: FastifySchema = {
|
||||
|
@ -1,19 +1,25 @@
|
||||
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'
|
||||
|
||||
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)
|
||||
}
|
||||
|
48
src/services/uploads/messages/delete.ts
Normal file
48
src/services/uploads/messages/delete.ts
Normal file
@ -0,0 +1,48 @@
|
||||
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 type { DeleteParameters } from '../../../tools/utils/deleteUploadedFile.js'
|
||||
import {
|
||||
deleteParameters,
|
||||
deleteUploadedFile
|
||||
} from '../../../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'
|
||||
})
|
||||
}
|
||||
})
|
||||
}
|
@ -1,7 +1,8 @@
|
||||
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'
|
||||
|
||||
|
@ -1,10 +1,10 @@
|
||||
import { Type } from '@sinclair/typebox'
|
||||
import { FastifyPluginAsync, FastifySchema } from 'fastify'
|
||||
import fastifyMultipart from 'fastify-multipart'
|
||||
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 { MAXIMUM_IMAGE_SIZE } from '../../../tools/configurations.js'
|
||||
import verifyAPIKey from '../../../tools/plugins/verifyAPIKey.js'
|
||||
|
||||
const postServiceSchema: FastifySchema = {
|
||||
|
48
src/services/uploads/users/delete.ts
Normal file
48
src/services/uploads/users/delete.ts
Normal file
@ -0,0 +1,48 @@
|
||||
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 type { DeleteParameters } from '../../../tools/utils/deleteUploadedFile.js'
|
||||
import {
|
||||
deleteParameters,
|
||||
deleteUploadedFile
|
||||
} from '../../../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'
|
||||
})
|
||||
}
|
||||
})
|
||||
}
|
@ -1,7 +1,8 @@
|
||||
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'
|
||||
|
||||
|
@ -1,13 +1,13 @@
|
||||
import { Type } from '@sinclair/typebox'
|
||||
import { FastifyPluginAsync, FastifySchema } from 'fastify'
|
||||
import fastifyMultipart from 'fastify-multipart'
|
||||
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,
|
||||
SUPPORTED_IMAGE_MIMETYPE
|
||||
} from '../../../tools/configurations/index.js'
|
||||
} from '../../../tools/configurations.js'
|
||||
import verifyAPIKey from '../../../tools/plugins/verifyAPIKey.js'
|
||||
|
||||
const postServiceSchema: FastifySchema = {
|
||||
|
@ -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 = 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)
|
||||
|
@ -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
|
||||
}
|
@ -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 '../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()
|
||||
@ -25,5 +25,5 @@ export default fastifyPlugin(
|
||||
request.apiKey = apiKey
|
||||
})
|
||||
},
|
||||
{ fastify: '3.x' }
|
||||
{ fastify: '4.x' }
|
||||
)
|
||||
|
52
src/tools/utils/deleteUploadedFile.ts
Normal file
52
src/tools/utils/deleteUploadedFile.ts
Normal 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 './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
|
||||
}
|
10
src/tools/utils/isExistingFile.ts
Normal file
10
src/tools/utils/isExistingFile.ts
Normal 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
|
||||
}
|
||||
}
|
@ -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 '../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: {
|
||||
@ -46,10 +46,10 @@ export const uploadFile = async (
|
||||
`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 +60,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}`
|
||||
|
@ -1,4 +1,5 @@
|
||||
{
|
||||
"extends": "@tsconfig/strictest/tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"target": "ESNext",
|
||||
"module": "ESNext",
|
||||
@ -7,7 +8,7 @@
|
||||
"outDir": "./build",
|
||||
"rootDir": "./src",
|
||||
"noEmit": true,
|
||||
"strict": true,
|
||||
"esModuleInterop": true
|
||||
"exactOptionalPropertyTypes": false,
|
||||
"checkJs": false
|
||||
}
|
||||
}
|
||||
|
Reference in New Issue
Block a user