Initial Setup

.editorconfig

@@ -3,14 +3,21 @@ root = true
 
 [*]
 charset = utf-8
-indent_style = space
+indent_style = tab
 indent_size = 2
 insert_final_newline = true
 trim_trailing_whitespace = true
+end_of_line = lf
 
 [*.ts]
 quote_type = single
 
 [*.md]
 max_line_length = off
 trim_trailing_whitespace = false
+
+[*.yml]
+indent_style = space
+
+[*.json]
+indent_style = space

.env.example

@@ -0,0 +1,46 @@
+API_PORT = 5000
+# Allowed URLs for CORS 'Access-Control-Allow-Origin' header
+CORS_ORIGIN_WHITELIST = 'https://ae.utbm.fr;'
+DEBUG = true
+
+# Postgres configuration
+# You can avoid user password when developing on local machine
+POSTGRES_DB = 'ae_test'
+POSTGRES_HOST = '127.0.0.1'
+POSTGRES_PORT = '5432'
+POSTGRES_USER = 'postgres'
+POSTGRES_PASSWORD = 'postgres'
+
+# JWT configuration
+# Note: changing the key will invalidate all existing tokens
+JWT_KEY = 'secret_jwt_key'
+JWT_EXPIRATION_TIME = 604800000 # 1 week in milliseconds
+
+# Base directory for generic uploaded files
+FILES_BASE_DIR = './public'
+
+# Users configuration
+# Delay before allowing the user to update its profile picture
+USERS_PICTURES_DELAY = 604800000 # 1 week in milliseconds
+USERS_PICTURES_PATH = './public/users/pictures'
+USERS_BANNERS_PATH = './public/users/banners'
+USERS_PATH = './public/users'
+
+# Promotion configuration
+PROMOTION_LOGO_PATH = './public/promotions'
+
+# Emailing configuration
+# Note: use your own UTBM email account when developing on local machine
+EMAIL_HOST = 'smtp.domain.com'
+EMAIL_PORT = 465
+EMAIL_SECURE = true
+EMAIL_AUTH_USER = '[email protected]'
+EMAIL_AUTH_PASS = 'azertyuiop'
+EMAIL_ENABLED = true
+
+# Whitelisted emails/host can be used to register
+WHITELISTED_HOSTS =
+WHITELISTED_EMAILS = '[email protected];[email protected]'
+# Blacklisted emails/host cannot be used to register
+BLACKLISTED_HOSTS = '@utbm.fr;'
+BLACKLISTED_EMAILS =

.eslintrc.cjs

@@ -0,0 +1,64 @@
+module.exports = {
+	parser: '@typescript-eslint/parser',
+	parserOptions: {
+		project: 'tsconfig.json',
+		tsconfigRootDir: __dirname,
+		sourceType: 'module',
+	},
+	plugins: ['@typescript-eslint', 'import'],
+	extends: [
+		'plugin:@typescript-eslint/recommended',
+		'plugin:@typescript-eslint/recommended-requiring-type-checking',
+		'plugin:prettier/recommended',
+		'plugin:import/recommended',
+		'plugin:import/typescript',
+	],
+	root: true,
+	env: {
+		node: true,
+		jest: true,
+	},
+	ignorePatterns: [
+		'.eslintrc.cjs',
+		'dist',
+		'node_modules',
+		'coverage',
+		'src/database/migrations',
+		'src/exported/api/@types/i18n.d.ts',
+	],
+	settings: {
+		'import/resolver': {
+			typescript: true,
+			node: true,
+		},
+	},
+	rules: {
+		'@typescript-eslint/ban-ts-comment': 'off',
+		'@typescript-eslint/interface-name-prefix': 'off',
+		'@typescript-eslint/explicit-function-return-type': 'off',
+		'@typescript-eslint/explicit-module-boundary-types': 'off',
+		'@typescript-eslint/no-unsafe-enum-comparison': 'off',
+		'@typescript-eslint/no-namespace': 'off',
+		'no-console': 'warn',
+		'prettier/prettier': ['error', { endOfLine: 'lf' }],
+		'import/export': 'off',
+		'import/order': [
+			'error',
+			{
+				'newlines-between': 'always',
+				groups: ['type', 'builtin', 'external', 'internal', ['parent', 'sibling', 'index']],
+				pathGroups: [
+					{
+						pattern: '@(database|modules|templates|utils|src)/**',
+						group: 'internal',
+					},
+				],
+				pathGroupsExcludedImportTypes: ['builtin'],
+				alphabetize: {
+					order: 'asc',
+					caseInsensitive: true,
+				},
+			},
+		],
+	},
+};

.github/CODE_OF_CONDUCT.md

@@ -1,4 +1,4 @@
-# Code de conduite - Sith 4
+# Code de conduite - API
 
 ## Nos engagements
 
@@ -8,19 +8,19 @@ Dans le but de favoriser un environnement ouvert et accueillant, nous, en tant q
 
 Les exemples de comportements qui contribuent à un environnement positif pour notre communauté :
 
-* Faire preuve d'empathie et de gentillesse envers les autres.
-* Respecter les opinions, les points de vue et les expériences différentes.
-* Émettre et accepter les commentaires constructifs
-* Accepter la responsabilité et s'excuser auprès des personnes affectées par nos erreurs, et apprendre de l'expérience
-* Se concentrer sur ce qui est le mieux non seulement pour nous en tant qu'individus, mais pour la communauté dans son ensemble
+- Faire preuve d'empathie et de gentillesse envers les autres.
+- Respecter les opinions, les points de vue et les expériences différentes.
+- Émettre et accepter les commentaires constructifs
+- Accepter la responsabilité et s'excuser auprès des personnes affectées par nos erreurs, et apprendre de l'expérience
+- Se concentrer sur ce qui est le mieux non seulement pour nous en tant qu'individus, mais pour la communauté dans son ensemble
 
 Voici quelques exemples de comportements inacceptables :
 
-* l'utilisation d'un langage ou d'images à caractère sexuel, et les attentions ou avances sexuelles.
-* le trollage, les commentaires insultants ou désobligeants et les attaques personnelles ou politiques
-* le harcèlement public ou privé
-* la publication d'informations privées d'autrui, telles qu'une adresse physique ou électronique, sans leur permission explicite.
-* toute autre conduite qui pourrait raisonnablement être considérée comme inappropriée dans un cadre professionnel.
+- l'utilisation d'un langage ou d'images à caractère sexuel, et les attentions ou avances sexuelles.
+- le trollage, les commentaires insultants ou désobligeants et les attaques personnelles ou politiques
+- le harcèlement public ou privé
+- la publication d'informations privées d'autrui, telles qu'une adresse physique ou électronique, sans leur permission explicite.
+- toute autre conduite qui pourrait raisonnablement être considérée comme inappropriée dans un cadre professionnel.
 
 ## Nos responsabilités
 

.github/CONTRIBUTING.md

@@ -1,5 +1,6 @@
 <!-- omit in toc -->
-# Contribuer au Sith 4
+
+# Contribuer à l'API
 
 Premièrement, merci de prendre le temps de contribuer ! ❤️
 
@@ -13,6 +14,7 @@ Tout type de contributions sont encouragée et valorisée. Veuillez consulter la
 > - Mentioner le projet lors de réunion locales et parler-en à vos amis/collègues
 
 <!-- omit in toc -->
+
 ## Table des matières
 
 - [Code de conduite](#code-de-conduite)
@@ -49,13 +51,14 @@ Nous nous occuperons alors du problème dans les plus brefs délais.
 ### Rapporter des Bugs
 
 <!-- omit in toc -->
+
 #### Avant de rapporter un bug
 
 Une bonne issue ne doit pas laisser les autres vous courir après afin d'obtenir davantage d'information. Ainsi, nous vous demandons d'enquêter attentivement, de collecter des informations et décrire le problème en détail dans votre rapport. Veuillez compléter les étapes suivantes à l'avance pour nous aider à résoudre le bug potentiel le plus rapidement possible.
 
 - Assurez-vous d'utiliser la dernière version.
 - Vérifiez si votre bug n'est pas en fait une erreur de votre côté, par exemple en utilisant des composants d'environnement/incompatibles (assurez-vous d'avoir lu la [documentation](https://github.com/ae-utbm/api/wiki).
-Si vous recherchez de l'aide, vous pouvez consulter [cette section](#jai-une-question)).
+  Si vous recherchez de l'aide, vous pouvez consulter [cette section](#jai-une-question)).
 - Pour voir si d'autres utilisateurs ont expérimentés (et potentiellement déjà résolu) le même problème que vous rencontrez, vérifiez si il n'y a pas déjà un rapport de bug existant pour votre bug ou erreur dans le [bug tracker](https://github.com/ae-utbm/sith4/issues?q=is%3Aissue+is%3Aclosed)
 - Assurez-vous de rechercher sur internet (y compris Stack Overflow) pour voir si d'autres utilisateurs hors de la communauté GitHub ont discuté du problème.
 - Collectez des informations sur le bug :
@@ -73,7 +76,7 @@ Nous utilisons les issues GitHub pour suivre les bugs et les erreurs. Si vous re
 
 - Ouvrez une [issue](https://github.com/ae-utbm/sith4/issues/new). (Comme nous ne pouvons pas être sûrs à ce stade de savoir si c'est un bug ou non, nous vous demandons de ne pas parler de bug et de ne pas ajouter de tag sur l'issue.)
 - Expliquer le comportement que vous attendez et le comportement réel.
-- Veuillez fournir autant de contexte que possible et décrire les *étapes de reproduction* que quelqu'un d'autre peut suivre pour recréer le problème sur son propre ordinateur. Cela inclut généralement votre code. Pour de bons rapports de bugs, vous devez isoler le problème et créer un cas de test réduit.
+- Veuillez fournir autant de contexte que possible et décrire les _étapes de reproduction_ que quelqu'un d'autre peut suivre pour recréer le problème sur son propre ordinateur. Cela inclut généralement votre code. Pour de bons rapports de bugs, vous devez isoler le problème et créer un cas de test réduit.
 - Si vous en avez la possibilité, incluez des captures d'écran et des vidéos qui montrent le problème.
 
 Une fois que c'est fait :
@@ -89,6 +92,7 @@ Cette section vous guide
 Cette section vous guide tout au long de la soumission d'une suggestion d'amélioration pour le Sith 4, **incluant des fonctionnalités entièrement nouvelles et des améliorations mineures des fonctionnalités existantes**. Suivre ces directives aidera les mainteneurs et la communauté à comprendre votre suggestion et à trouver des suggestions connexes.
 
 <!-- omit in toc -->
+
 #### Avant de soumettre une amélioration
 
 - Assurez-vous que vous utilisez la dernière version.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,8 +1,8 @@
 name: 🐛 Rapport de bug
 description: Remplissez un rapport de bug
-title: "[BUG] "
-labels: ["type: bug", "status: triage"]
-assignees: "developers-v4"
+title: '[BUG] '
+labels: ['type: bug', 'status: triage']
+assignees: 'developers-v4'
 body:
   - type: markdown
     attributes:

.github/ISSUE_TEMPLATE/feature_report.yml

@@ -1,8 +1,8 @@
 name: ✨ Suggestion d'amélioration
 description: Suggérez une idée pour le projet
-title: "[FEATURE] "
-labels: ["type: feature", "status: triage"]
-assignees: "developers-v4"
+title: '[FEATURE] '
+labels: ['type: feature', 'status: triage']
+assignees: 'developers-v4'
 body:
   - type: markdown
     attributes:
@@ -37,4 +37,3 @@ body:
       options:
         - label: "J'accepte de suivre le code de conduite de ce projet"
           required: true
-

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: 'npm' # See documentation for possible values
+    directory: '/' # Location of package manifests
+    schedule:
+      interval: 'weekly'

.github/workflows/analyze.yml

@@ -0,0 +1,36 @@
+name: Code QL Analysis
+
+# Description:
+# - This workflow runs CodeQL analysis on the codebase.
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  codeql:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Init CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: javascript # typescript is recognized as javascript
+          queries: +security-extended,security-and-quality
+
+      - name: Build CodeQL Database
+        uses: github/codeql-action/autobuild@v2
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: '/language:javascript'

.github/workflows/linting.yml

@@ -0,0 +1,32 @@
+name: Code Linting
+
+# Description:
+# - This workflow runs linting on the codebase, fails if linting does not pass.
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+
+      - name: Install pnpm
+        run: npm install -g pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Lint Typescript
+        run: pnpm workflow:lint