th-97: Implement mail service (#107)

* th-97: + mail service

* th-97: + views (only 'plain' view at the moment)

* th-97: * comment fixes

* th-97: * fix PR comments

* th-97: * Resolved PR comments

Author: mV22110702

backend/.env.example

@@ -11,6 +11,14 @@ 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
 #

backend/package.json

@@ -35,6 +35,7 @@
     "@types/bcryptjs": "2.4.3",
     "@types/convict": "6.1.3",
     "@types/swagger-jsdoc": "6.0.1",
+    "@types/nodemailer": "6.4.9",
     "bcryptjs": "2.4.3",
     "convict": "6.2.4",
     "dotenv": "16.3.1",
@@ -43,6 +44,8 @@
     "fastify": "4.21.0",
     "fastify-plugin": "4.5.1",
     "jose": "4.14.4",
+    "handlebars": "4.7.8",
+    "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,17 +1,14 @@
-import { type ValueOf } from '~/libs/types/types.js';
+import { AppErrorMessage, HttpCode } from '~/libs/enums/enums.js';
+import { type ErrorConstructor, type ValueOf } from '~/libs/types/types.js';
 
-import { AppErrorMessage, HttpCode } from '../../enums/enums.js';
 import { ApplicationError } from '../exceptions.js';
 
-type Constructor = {
-  message?: string;
-  cause?: unknown;
-};
+type NotFoundErrorConstructor = Partial<ErrorConstructor>;
 
 class NotFoundError extends ApplicationError {
   public status: ValueOf<typeof HttpCode>;
 
-  public constructor({ message, cause }: Constructor) {
+  public constructor({ message, cause }: NotFoundErrorConstructor) {
     super({
       message: message ?? AppErrorMessage.ENTITY_NOT_FOUND,
       cause,

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,32 @@ 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,
+        },
+      },
     });
   }
 }

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

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

backend/src/libs/packages/config/libs/types/environment-schema.type.ts

@@ -16,6 +16,12 @@ type EnvironmentSchema = {
     POOL_MIN: number;
     POOL_MAX: number;
   };
+  MAILER: {
+    SENDGRID_API_KEY: string;
+    SENDGRID_USER: string;
+    SMTP_TLS: boolean;
+    SENDGRID_SENDER_EMAIL: string;
+  };
 };
 
 export { type EnvironmentSchema };