chore: better Prettier config for easier reviews

This commit is contained in:
Théo LUDWIG 2023-10-23 23:41:21 +02:00
parent aaf4e2c4c6
commit d638d7b3d4
Signed by: theoludwig
GPG Key ID: ADFE5A563D718F3B
32 changed files with 1330 additions and 1272 deletions

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,4 +1,4 @@
name: 'Build'
name: "Build"
on:
push:
@ -8,20 +8,20 @@ on:
jobs:
build:
runs-on: 'ubuntu-latest'
runs-on: "ubuntu-latest"
steps:
- uses: 'actions/checkout@v4.0.0'
- uses: "actions/checkout@v4.0.0"
- name: 'Setup Node.js'
uses: 'actions/setup-node@v3.8.1'
- name: "Setup Node.js"
uses: "actions/setup-node@v3.8.1"
with:
node-version: '20.x'
cache: 'npm'
node-version: "20.x"
cache: "npm"
- name: 'Install dependencies'
run: 'npm clean-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'
- 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@v4.0.0'
- uses: "actions/checkout@v4.0.0"
- name: 'Setup Node.js'
uses: 'actions/setup-node@v3.8.1'
- name: "Setup Node.js"
uses: "actions/setup-node@v3.8.1"
with:
node-version: '20.x'
cache: 'npm'
node-version: "20.x"
cache: "npm"
- name: 'Install dependencies'
run: 'npm clean-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:eslint'
run: 'npm run lint:eslint'
- 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.18.0'
- 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,36 +6,36 @@ on:
jobs:
release:
runs-on: 'ubuntu-latest'
runs-on: "ubuntu-latest"
steps:
- uses: 'actions/checkout@v4.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@v6.0.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
- name: 'Setup Node.js'
uses: 'actions/setup-node@v3.8.1'
- name: "Setup Node.js"
uses: "actions/setup-node@v3.8.1"
with:
node-version: '20.x'
cache: 'npm'
node-version: "20.x"
cache: "npm"
- name: 'Install dependencies'
run: 'npm clean-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'
- run: "npm run build:typescript"
- name: 'Release'
run: 'npm run release'
- name: "Release"
run: "npm run release"
env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
GIT_COMMITTER_NAME: ${{ secrets.GIT_NAME }}

View File

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

View File

@ -1,21 +1,21 @@
FROM node:20.6.1 AS builder-dependencies
FROM node:20.9.0 AS builder-dependencies
WORKDIR /usr/src/application
COPY ./package*.json ./
RUN npm clean-install
FROM node:20.6.1 AS runner-dependencies
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.6.1 AS builder
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-debian11:latest AS runner
FROM gcr.io/distroless/nodejs20-debian12:latest AS runner
WORKDIR /usr/src/application
ENV NODE_ENV=production
ENV NODE_OPTIONS=--enable-source-maps

View File

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

1845
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -31,50 +31,50 @@
"postinstall": "husky install"
},
"dependencies": {
"@fastify/cors": "8.3.0",
"@fastify/cors": "8.4.0",
"@fastify/helmet": "11.1.1",
"@fastify/multipart": "7.7.3",
"@fastify/multipart": "8.0.0",
"@fastify/rate-limit": "8.0.3",
"@fastify/sensible": "5.3.0",
"@fastify/sensible": "5.5.0",
"@fastify/static": "6.11.2",
"@fastify/swagger": "8.10.0",
"@fastify/swagger-ui": "1.9.3",
"@sinclair/typebox": "0.31.15",
"@fastify/swagger": "8.12.0",
"@fastify/swagger-ui": "1.10.1",
"@sinclair/typebox": "0.31.18",
"dotenv": "16.3.1",
"fastify": "4.23.2",
"fastify": "4.24.3",
"fastify-plugin": "4.5.1",
"http-errors": "2.0.0",
"read-pkg": "8.1.0"
},
"devDependencies": {
"@commitlint/cli": "17.7.1",
"@commitlint/config-conventional": "17.7.0",
"@saithodev/semantic-release-backmerge": "3.2.0",
"@commitlint/cli": "18.0.0",
"@commitlint/config-conventional": "18.0.0",
"@saithodev/semantic-release-backmerge": "3.2.1",
"@semantic-release/git": "10.0.1",
"@swc/cli": "0.1.62",
"@swc/core": "1.3.85",
"@swc/core": "1.3.94",
"@tsconfig/strictest": "2.0.2",
"@types/busboy": "1.5.1",
"@types/http-errors": "2.0.2",
"@types/node": "20.6.2",
"@typescript-eslint/eslint-plugin": "6.7.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.1",
"concurrently": "8.2.2",
"cross-env": "7.0.3",
"editorconfig-checker": "5.1.1",
"eslint": "8.49.0",
"eslint-config-conventions": "11.0.1",
"eslint": "8.52.0",
"eslint-config-conventions": "12.0.0",
"eslint-config-prettier": "9.0.0",
"eslint-plugin-import": "2.28.1",
"eslint-plugin-prettier": "5.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": "14.0.1",
"lint-staged": "15.0.2",
"markdownlint-cli2": "0.10.0",
"markdownlint-rule-relative-links": "2.1.0",
"prettier": "3.0.3",
"rimraf": "5.0.1",
"rimraf": "5.0.5",
"semantic-release": "21.1.2",
"typescript": "5.2.2"
}

View File

@ -1,32 +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 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 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 '#src/services/index.js'
import { UPLOADS_URL } from '#src/tools/configurations.js'
import { services } from "#src/services/index.js"
import { UPLOADS_URL } from "#src/tools/configurations.js"
dotenv.config()
const packageJSON = await readPackage()
export const application = fastify({
logger: process.env['NODE_ENV'] === 'development',
logger: process.env["NODE_ENV"] === "development",
ajv: {
customOptions: {
strict: 'log',
keywords: ['kind', 'modifier'],
strict: "log",
keywords: ["kind", "modifier"],
formats: {
full: true
}
}
}
full: true,
},
},
},
})
await application.register(fastifyCors)
@ -34,34 +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
version: packageJSON.version,
},
tags: [{ name: 'users' }, { name: 'guilds' }, { name: 'messages' }],
tags: [{ name: "users" }, { name: "guilds" }, { name: "messages" }],
components: {
securitySchemes: {
apiKeyAuth: {
type: 'apiKey',
name: 'X-API-KEY',
in: 'header'
}
}
}
type: "apiKey",
name: "X-API-KEY",
in: "header",
},
hideUntagged: true
},
},
},
hideUntagged: true,
})
await application.register(fastifySwaggerUI, {
routePrefix: '/documentation',
staticCSP: true
routePrefix: "/documentation",
staticCSP: true,
})
await application.register(services)

View File

@ -1,8 +1,8 @@
import { application } from '#src/application.js'
import { HOST, PORT } from '#src/tools/configurations.js'
import { application } from "#src/application.js"
import { HOST, PORT } from "#src/tools/configurations.js"
const address = await application.listen({
port: PORT,
host: HOST
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 type { FastifyPluginAsync } from 'fastify'
import type { FastifyPluginAsync } from "fastify"
import { uploadsService } from '#src/services/uploads/index.js'
import { uploadsService } from "#src/services/uploads/index.js"
export const services: FastifyPluginAsync = async (fastify) => {
await fastify.register(uploadsService)

View File

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

View File

@ -1,41 +1,41 @@
import path from 'node:path'
import path from "node:path"
import type { FastifyPluginAsync, FastifySchema } from 'fastify'
import type { Static } from '@sinclair/typebox'
import { Type } from '@sinclair/typebox'
import type { FastifyPluginAsync, FastifySchema } from "fastify"
import type { Static } from "@sinclair/typebox"
import { Type } from "@sinclair/typebox"
import { fastifyErrors } from '#src/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 type { 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 '#src/models/utils.js'
import { uploadFile } from '#src/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 '#src/tools/configurations.js'
import verifyAPIKey from '#src/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,14 +1,14 @@
import type { FastifyPluginAsync } from 'fastify'
import type { FastifyPluginAsync } from "fastify"
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'
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)

View File

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

View File

@ -1,43 +1,43 @@
import path from 'node:path'
import path from "node:path"
import type { FastifyPluginAsync, FastifySchema } from 'fastify'
import type { Static } from '@sinclair/typebox'
import { Type } from '@sinclair/typebox'
import type { FastifyPluginAsync, FastifySchema } from "fastify"
import type { Static } from "@sinclair/typebox"
import { Type } from "@sinclair/typebox"
import { fastifyErrors } from '#src/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 type { 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 '#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'
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

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

View File

@ -1,41 +1,41 @@
import path from 'node:path'
import path from "node:path"
import type { FastifyPluginAsync, FastifySchema } from 'fastify'
import type { Static } from '@sinclair/typebox'
import { Type } from '@sinclair/typebox'
import type { FastifyPluginAsync, FastifySchema } from "fastify"
import type { Static } from "@sinclair/typebox"
import { Type } from "@sinclair/typebox"
import { fastifyErrors } from '#src/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 type { 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 '#src/models/utils.js'
import { uploadFile } from '#src/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 '#src/tools/configurations.js'
import verifyAPIKey from '#src/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

@ -1,23 +1,23 @@
import { URL } from 'node:url'
import { URL } from "node:url"
import dotenv from 'dotenv'
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 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 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'
"image/png",
"image/jpg",
"image/jpeg",
"image/gif",
]
/** in megabytes */

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 '#src/tools/configurations.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) => {
fastify.decorateRequest('apiKey', undefined)
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: '4.x' }
{ fastify: "4.x" },
)

View File

@ -1,27 +1,27 @@
import type { IncomingMessage, Server, ServerResponse } from 'node:http'
import { fileURLToPath } from 'node:url'
import fs from 'node:fs'
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 { Static } from "@sinclair/typebox"
import { Type } from "@sinclair/typebox"
import type {
FastifyBaseLogger,
FastifyInstance,
FastifyReply,
FastifyRequest,
FastifyTypeProviderDefault
} from 'fastify'
FastifyTypeProviderDefault,
} from "fastify"
import { isExistingFile } from '#src/tools/utils/isExistingFile.js'
import { isExistingFile } from "#src/tools/utils/isExistingFile.js"
export const deleteParameters = Type.Object({
file: Type.String()
file: Type.String(),
})
export type DeleteParameters = Static<typeof deleteParameters>
export interface DeleteUploadedFileOptions {
folder: 'guilds' | 'messages' | 'users'
folder: "guilds" | "messages" | "users"
fastify: FastifyInstance<
Server<typeof IncomingMessage, typeof ServerResponse>,
IncomingMessage,
@ -34,7 +34,7 @@ export interface DeleteUploadedFileOptions {
}
export const deleteUploadedFile = async (
options: DeleteUploadedFileOptions
options: DeleteUploadedFileOptions,
): Promise<string> => {
const { request, fastify, reply, folder } = options
if (request.apiKey == null) {
@ -44,7 +44,7 @@ export const deleteUploadedFile = async (
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')
throw fastify.httpErrors.notFound("File does not exist")
}
await fs.promises.rm(filePath, { force: true })
reply.statusCode = 200

View File

@ -1,4 +1,4 @@
import fs from 'node:fs'
import fs from "node:fs"
export const isExistingFile = async (path: string): Promise<boolean> => {
try {

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 type { FastifyInstance, FastifyRequest } from 'fastify'
import type { SavedMultipartFile } from '@fastify/multipart'
import type { FastifyInstance, FastifyRequest } from "fastify"
import type { SavedMultipartFile } from "@fastify/multipart"
import { API_URL, ROOT_URL } from '#src/tools/configurations.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,45 +24,45 @@ export interface UploadFileResult {
}
export const uploadFile = async (
options: UploadFileOptions
options: UploadFileOptions,
): Promise<UploadFileResult> => {
const {
fastify,
request,
folderInUploadsFolder,
maximumFileSize,
supportedFileMimetype
supportedFileMimetype,
} = options
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.`,
)
}
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.")
}
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.')
throw fastify.httpErrors.badRequest("The file extension is not valid.")
}
const filePath = `uploads/${folderInUploadsFolder}/${randomUUID()}.${fileExtension}`
const fileURL = new URL(filePath, ROOT_URL)