Merge branch 'development' into fix/th-183-fix-the-phone-field

Author: Druxight

.stylelintrc.yml

@@ -8,7 +8,7 @@ rules:
   selector-class-pattern: null
   color-hex-length: long
   declaration-no-important: true
-  max-nesting-depth: 0
+  max-nesting-depth: 2
   no-descending-specificity: true
   scss/at-import-partial-extension: always
   import-notation: string

backend/.env.example

@@ -11,10 +11,23 @@ JWT_SECRET=very_secret_secret
 JWT_ISSUER=jwt_issuer
 JWT_ACCESS_LIFETIME=24h
 
+#
+# SENDGRID
+#
+SENDGRID_API_KEY=YOUR_API_KEY
+SENDGRID_USER=apikey
+SENDGRID_SENDER_EMAIL=YOUR_VERIFIED_SENDER_EMAIL
+SMTP_TLS=true
+
 #
 # DATABASE
 #
 DB_CONNECTION_STRING=[db_client]://[db_username]:[db_user_password]@localhost:[db_port]/[db_name]
 DB_DIALECT=pg
 DB_POOL_MIN=2
 DB_POOL_MAX=10
+
+#
+# API
+#
+GOOGLE_MAPS_API_KEY=YOUR_API_KEY

backend/package.json

@@ -28,11 +28,14 @@
   },
   "dependencies": {
     "@fastify/auth": "4.3.0",
+    "@fastify/cors": "8.3.0",
     "@fastify/static": "6.10.2",
     "@fastify/swagger": "8.9.0",
     "@fastify/swagger-ui": "1.9.3",
+    "@googlemaps/google-maps-services-js": "3.3.38",
     "@types/bcryptjs": "2.4.3",
     "@types/convict": "6.1.3",
+    "@types/nodemailer": "6.4.9",
     "@types/swagger-jsdoc": "6.0.1",
     "bcryptjs": "2.4.3",
     "convict": "6.2.4",
@@ -41,7 +44,9 @@
     "drizzle-orm": "0.28.2",
     "fastify": "4.21.0",
     "fastify-plugin": "4.5.1",
+    "handlebars": "4.7.8",
     "jose": "4.14.4",
+    "nodemailer": "6.9.4",
     "pg": "8.11.3",
     "pino": "8.15.0",
     "pino-pretty": "10.2.0",

backend/src/libs/exceptions/database/database-connection.exception.ts

@@ -1,7 +1,7 @@
-import { type Constructor } from '~/libs/types/types.js';
+import { type ErrorConstructor } from '~/libs/types/types.js';
 
 class DatabaseConnectionError extends Error {
-  public constructor({ message, cause }: Constructor) {
+  public constructor({ message, cause }: ErrorConstructor) {
     super(message, {
       cause,
     });

backend/src/libs/exceptions/exceptions.ts

@@ -1,7 +1,9 @@
 export { DatabaseConnectionError } from './database/database.js';
+export { MailerConnectionError } from './mailer/mailer.js';
 export { NotFoundError } from './not-found-error/not-found-error.exception.js';
 export {
   ApplicationError,
+  ConfigValidationError,
   HttpError,
   ValidationError,
 } from 'shared/build/index.js';

backend/src/libs/exceptions/mailer/mailer-connection.exception.ts

@@ -0,0 +1,11 @@
+import { type ErrorConstructor } from '~/libs/types/types.js';
+
+class MailerConnectionError extends Error {
+  public constructor({ message, cause }: ErrorConstructor) {
+    super(message, {
+      cause,
+    });
+  }
+}
+
+export { MailerConnectionError };

backend/src/libs/exceptions/mailer/mailer.ts

@@ -0,0 +1 @@
+export { MailerConnectionError } from './mailer-connection.exception.js';

backend/src/libs/exceptions/not-found-error/not-found-error.exception.ts

@@ -1,23 +1,18 @@
-import { type ValueOf } from '~/libs/types/types.js';
-
 import { AppErrorMessage, HttpCode } from '../../enums/enums.js';
-import { ApplicationError } from '../exceptions.js';
+import { HttpError } from '../exceptions.js';
 
 type Constructor = {
   message?: string;
   cause?: unknown;
 };
 
-class NotFoundError extends ApplicationError {
-  public status: ValueOf<typeof HttpCode>;
-
+class NotFoundError extends HttpError {
   public constructor({ message, cause }: Constructor) {
     super({
       message: message ?? AppErrorMessage.ENTITY_NOT_FOUND,
+      status: HttpCode.NOT_FOUND,
       cause,
     });
-
-    this.status = HttpCode.NOT_FOUND;
   }
 }
 

backend/src/libs/packages/config/config.package.ts

@@ -2,8 +2,10 @@ import convict, { type Config as TConfig } from 'convict';
 import { config } from 'dotenv';
 
 import { AppEnvironment } from '~/libs/enums/enums.js';
+import { ConfigValidationError } from '~/libs/exceptions/exceptions.js';
 import { type ILogger } from '~/libs/packages/logger/logger.js';
 
+import { FormatRegex } from './libs/enums/enums.js';
 import { type IConfig } from './libs/interfaces/interfaces.js';
 import { type EnvironmentSchema } from './libs/types/types.js';
 
@@ -28,6 +30,28 @@ class Config implements IConfig {
   }
 
   private get envSchema(): TConfig<EnvironmentSchema> {
+    convict.addFormat({
+      name: 'boolean_string',
+      validate: (value: string, schema: convict.SchemaObj) => {
+        if (value !== 'true' && value !== 'false') {
+          throw new ConfigValidationError({
+            message: `Invalid ${schema.env ?? ''} format`,
+          });
+        }
+      },
+    });
+
+    convict.addFormat({
+      name: 'email',
+      validate: (value: string, schema: convict.SchemaObj) => {
+        if (!FormatRegex.EMAIL.test(value)) {
+          throw new ConfigValidationError({
+            message: `Invalid ${schema.env ?? ''} format`,
+          });
+        }
+      },
+    });
+
     return convict<EnvironmentSchema>({
       APP: {
         ENVIRONMENT: {
@@ -83,6 +107,40 @@ class Config implements IConfig {
           default: null,
         },
       },
+      MAILER: {
+        SENDGRID_API_KEY: {
+          doc: 'Twilio SendGrid API key',
+          format: String,
+          env: 'SENDGRID_API_KEY',
+          default: null,
+        },
+        SENDGRID_USER: {
+          doc: 'Twilio SendGrid SMTP username',
+          format: String,
+          env: 'SENDGRID_USER',
+          default: 'apikey',
+        },
+        SMTP_TLS: {
+          doc: 'Whether SMTP connection uses TLS',
+          env: 'SMTP_TLS',
+          format: 'boolean_string',
+          default: true,
+        },
+        SENDGRID_SENDER_EMAIL: {
+          doc: 'Sendgrid verified sender email',
+          env: 'SENDGRID_SENDER_EMAIL',
+          format: 'email',
+          default: null,
+        },
+      },
+      API: {
+        GOOGLE_MAPS_API_KEY: {
+          doc: 'Key for Google maps API',
+          format: String,
+          env: 'GOOGLE_MAPS_API_KEY',
+          default: null,
+        },
+      },
     });
   }
 }

backend/src/libs/packages/config/libs/enums/enums.ts

@@ -0,0 +1 @@
+export { FormatRegex } from 'shared/build/index.js';