Thream/file-uploads-api
Archived
2
1
Fork 0
Code Issues Pull Requests Releases Activity

fix: update dependencies to latest

Browse Source
This commit is contained in:
Théo LUDWIG 2023-07-22 16:24:52 +02:00
parent d83092bd34
commit 5a2bec6706
Signed by: theoludwig
GPG Key ID: ADFE5A563D718F3B
30 changed files with 1187 additions and 765 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.dockerignore Normal file
View File

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

1
.env.example
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

4
.eslintrc.json
View File

@ -1,12 +1,10 @@
{
"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"],

2
.github/workflows/build.yml vendored
View File

@ -15,7 +15,7 @@ jobs:
- name: 'Setup Node.js'
uses: 'actions/setup-node@v3.6.0'
with:
node-version: '18.x'
node-version: '20.x'
cache: 'npm'
- name: 'Install dependencies'

2
.github/workflows/lint.yml vendored
View File

@ -15,7 +15,7 @@ jobs:
- name: 'Setup Node.js'
uses: 'actions/setup-node@v3.6.0'
with:
node-version: '18.x'
node-version: '20.x'
cache: 'npm'
- name: 'Install dependencies'

2
.github/workflows/release.yml vendored
View File

@ -23,7 +23,7 @@ jobs:
- name: 'Setup Node.js'
uses: 'actions/setup-node@v3.6.0'
with:
node-version: '18.x'
node-version: '20.x'
cache: 'npm'
- name: 'Install dependencies'

14
.swcrc
View File

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

26
Dockerfile Normal file
View File

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

8
README.md
View File

@ -1,4 +1,4 @@
<h1 align="center"><a href="https://file-uploads-api.thream.divlo.fr/documentation">Thream/file-uploads-api</a></h1>
<h1 align="center"><a href="https://file-uploads-api.thream.theoludwig.fr/documentation">Thream/file-uploads-api</a></h1>
<p align="center">
<a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" /></a>
@ -52,6 +52,12 @@ npm run dev
- `file-uploads-api`: <http://127.0.0.1:8000>
### Production environment (with [Docker](https://www.docker.com/))
```sh
docker compose up --build
```
## 💡 Contributing
Anyone can help to improve the project, submit a Feature Request, a bug report or

11
docker-compose.yml Normal file
View File

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

1732
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

44
package.json
View File

@ -4,6 +4,9 @@
"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"
@ -21,8 +24,8 @@
"lint:commit": "commitlint",
"lint:editorconfig": "editorconfig-checker",
"lint:markdown": "markdownlint-cli2",
"lint:eslint": "eslint . --ignore-path .gitignore",
"lint:prettier": "prettier . --check --ignore-path .gitignore",
"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"
@ -30,48 +33,49 @@
"dependencies": {
"@fastify/cors": "8.3.0",
"@fastify/helmet": "11.0.0",
"@fastify/multipart": "7.7.0",
"@fastify/rate-limit": "8.0.1",
"@fastify/multipart": "7.6.0",
"@fastify/rate-limit": "8.0.3",
"@fastify/sensible": "5.2.0",
"@fastify/static": "6.10.2",
"@fastify/swagger": "8.6.0",
"@fastify/swagger": "8.8.0",
"@fastify/swagger-ui": "1.9.2",
"@sinclair/typebox": "0.29.0",
"@sinclair/typebox": "0.29.6",
"dotenv": "16.3.1",
"fastify": "4.19.1",
"fastify-plugin": "4.5.0",
"fastify": "4.20.0",
"fastify-plugin": "4.5.1",
"http-errors": "2.0.0",
"read-pkg": "8.0.0"
},
"devDependencies": {
"@commitlint/cli": "17.6.6",
"@commitlint/config-conventional": "17.6.6",
"@commitlint/cli": "17.6.7",
"@commitlint/config-conventional": "17.6.7",
"@saithodev/semantic-release-backmerge": "3.2.0",
"@semantic-release/git": "10.0.1",
"@swc/cli": "0.1.62",
"@swc/core": "1.3.67",
"@swc/core": "1.3.70",
"@tsconfig/strictest": "2.0.1",
"@types/busboy": "1.5.0",
"@types/http-errors": "2.0.1",
"@types/node": "20.3.3",
"@typescript-eslint/eslint-plugin": "5.60.1",
"@types/node": "20.4.3",
"@typescript-eslint/eslint-plugin": "6.1.0",
"chokidar": "3.5.3",
"concurrently": "8.2.0",
"cross-env": "7.0.3",
"editorconfig-checker": "5.1.1",
"eslint": "8.44.0",
"eslint-config-conventions": "10.0.0",
"eslint": "8.45.0",
"eslint-config-conventions": "11.0.1",
"eslint-config-prettier": "8.8.0",
"eslint-plugin-import": "2.27.5",
"eslint-plugin-prettier": "4.2.1",
"eslint-plugin-prettier": "5.0.0",
"eslint-plugin-promise": "6.1.1",
"eslint-plugin-unicorn": "47.0.0",
"eslint-plugin-unicorn": "48.0.0",
"husky": "8.0.3",
"lint-staged": "13.2.3",
"markdownlint-cli2": "0.8.1",
"markdownlint-rule-relative-links": "2.1.0",
"prettier": "2.8.8",
"prettier": "3.0.0",
"rimraf": "5.0.1",
"semantic-release": "21.0.6",
"typescript": "5.0.4"
"semantic-release": "21.0.7",
"typescript": "5.1.6"
}
}

4
src/application.ts
View File

@ -11,8 +11,8 @@ import fastifySensible from '@fastify/sensible'
import fastifyStatic from '@fastify/static'
import { readPackage } from 'read-pkg'
import { services } from './services/index.js'
import { UPLOADS_URL } from './tools/configurations.js'
import { services } from '#src/services/index.js'
import { UPLOADS_URL } from '#src/tools/configurations.js'
dotenv.config()
const packageJSON = await readPackage()

6
src/index.ts
View File

@ -1,8 +1,8 @@
import { application } from './application.js'
import { HOST, PORT } from './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
})
console.log('\u001B[36m%s\u001B[0m', `🚀 Server listening at ${address}`)
console.log(`Server listening at ${address}`)

2
src/services/index.ts
View File

@ -1,6 +1,6 @@
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)

8
src/services/uploads/guilds/delete.ts
View File

@ -1,13 +1,13 @@
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 { 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 '../../../tools/utils/deleteUploadedFile.js'
} from '#src/tools/utils/deleteUploadedFile.js'
export const deleteServiceSchema: FastifySchema = {
tags: ['guilds'] as string[],

2
src/services/uploads/guilds/get.ts
View File

@ -4,7 +4,7 @@ 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()

8
src/services/uploads/guilds/post.ts
View File

@ -2,13 +2,13 @@ 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.js'
import verifyAPIKey from '../../../tools/plugins/verifyAPIKey.js'
} from '#src/tools/configurations.js'
import verifyAPIKey from '#src/tools/plugins/verifyAPIKey.js'
const postServiceSchema: FastifySchema = {
description: 'Uploads guild icon',

18
src/services/uploads/index.ts
View File

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

8
src/services/uploads/messages/delete.ts
View File

@ -1,13 +1,13 @@
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 { 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 '../../../tools/utils/deleteUploadedFile.js'
} from '#src/tools/utils/deleteUploadedFile.js'
export const deleteServiceSchema: FastifySchema = {
tags: ['messages'] as string[],

2
src/services/uploads/messages/get.ts
View File

@ -4,7 +4,7 @@ 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()

8
src/services/uploads/messages/post.ts
View File

@ -2,10 +2,10 @@ 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.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',

8
src/services/uploads/users/delete.ts
View File

@ -1,13 +1,13 @@
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 { 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 '../../../tools/utils/deleteUploadedFile.js'
} from '#src/tools/utils/deleteUploadedFile.js'
export const deleteServiceSchema: FastifySchema = {
tags: ['users'] as string[],

2
src/services/uploads/users/get.ts
View File

@ -4,7 +4,7 @@ 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()

8
src/services/uploads/users/post.ts
View File

@ -2,13 +2,13 @@ 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.js'
import verifyAPIKey from '../../../tools/plugins/verifyAPIKey.js'
} from '#src/tools/configurations.js'
import verifyAPIKey from '#src/tools/plugins/verifyAPIKey.js'
const postServiceSchema: FastifySchema = {
description: 'Uploads user logo',

2
src/tools/configurations.ts
View File

@ -4,7 +4,7 @@ import dotenv from 'dotenv'
dotenv.config()
export const PORT = parseInt(process.env['PORT'] ?? '8000', 10)
export const PORT = Number.parseInt(process.env['PORT'] ?? '8000', 10)
export const HOST = process.env['HOST'] ?? '0.0.0.0'
export const API_URL = process.env['API_URL'] ?? `http://${HOST}:${PORT}`
export const API_KEY = process.env['API_KEY'] ?? 'apiKeySecret'

2
src/tools/plugins/verifyAPIKey.ts
View File

@ -1,7 +1,7 @@
import fastifyPlugin from 'fastify-plugin'
import httpErrors from 'http-errors'
import { API_KEY } from '../configurations.js'
import { API_KEY } from '#src/tools/configurations.js'
const { Unauthorized, Forbidden } = httpErrors

2
src/tools/utils/deleteUploadedFile.ts
View File

@ -12,7 +12,7 @@ import type {
FastifyTypeProviderDefault
} from 'fastify'
import { isExistingFile } from './isExistingFile.js'
import { isExistingFile } from '#src/tools/utils/isExistingFile.js'
export const deleteParameters = Type.Object({
file: Type.String()

3
src/tools/utils/uploadFile.ts
View File

@ -5,7 +5,7 @@ import { randomUUID } from 'node:crypto'
import type { FastifyInstance, FastifyRequest } from 'fastify'
import type { SavedMultipartFile } from '@fastify/multipart'
import { API_URL, ROOT_URL } from '../configurations.js'
import { API_URL, ROOT_URL } from '#src/tools/configurations.js'
export interface UploadFileOptions {
folderInUploadsFolder: 'guilds' | 'messages' | 'users'
@ -42,6 +42,7 @@ export const uploadFile = async (
}
})
} catch (error) {
console.error(error)
throw fastify.httpErrors.requestHeaderFieldsTooLarge(
`File should be less than ${maximumFileSize}mb.`
)

6
tsconfig.json
View File

@ -4,9 +4,13 @@
"target": "ESNext",
"module": "ESNext",
"lib": ["ESNext"],
"moduleResolution": "node",
"moduleResolution": "Node",
"outDir": "./build",
"rootDir": "./src",
"baseUrl": ".",
"paths": {
"#src/*": ["./src/*"]
},
"noEmit": true,
"exactOptionalPropertyTypes": false,
"checkJs": false