feat: add lib smtp

Author: masb0ymas

src/config/smtp.ts

@@ -0,0 +1,17 @@
+import Nodemailer from '~/lib/smtp/nodemailer'
+import { env } from './env'
+
+export const smtp = new Nodemailer({
+  transporter: {
+    host: env.MAIL_HOST,
+    port: env.MAIL_PORT,
+    secure: env.MAIL_ENCRYPTION === 'ssl',
+    auth: {
+      user: env.MAIL_USERNAME,
+      pass: env.MAIL_PASSWORD,
+    },
+  },
+  defaults: {
+    from: env.MAIL_FROM,
+  },
+})

src/lib/smtp/nodemailer.ts

@@ -0,0 +1,65 @@
+import { green } from 'colorette'
+import nodemailer from 'nodemailer'
+import SMTPTransport from 'nodemailer/lib/smtp-transport'
+import { logger } from '~/config/logger'
+import { NodemailerParams } from './types'
+
+export default class Nodemailer {
+  private _transporter: SMTPTransport | SMTPTransport.Options
+  private _default: SMTPTransport.Options | undefined
+
+  constructor({ transporter, defaults }: NodemailerParams) {
+    this._transporter = transporter
+    this._default = defaults
+  }
+
+  /**
+   * Creates a nodemailer client
+   * @returns nodemailer client
+   */
+  private _client() {
+    return nodemailer.createTransport(this._transporter, this._default)
+  }
+
+  /**
+   * Initializes the nodemailer client
+   * @returns nodemailer client
+   */
+  async initialize() {
+    const transporter = this._client()
+    const msgType = `${green('nodemailer')}`
+
+    try {
+      const isValid = await transporter.verify()
+      if (!isValid) {
+        logger.error(`${msgType} failed to initialize Nodemailer`)
+        process.exit(1)
+      }
+
+      logger.info(`${msgType} initialized successfully`)
+      return transporter
+    } catch (error: any) {
+      logger.error(`${msgType} failed to initialize: ${error?.message ?? error}`)
+      process.exit(1)
+    }
+  }
+
+  /**
+   * Sends an email
+   * @param options - options for sending an email
+   * @returns email info
+   */
+  async send(options: nodemailer.SendMailOptions) {
+    const transporter = this._client()
+    const msgType = `${green('nodemailer')}`
+
+    try {
+      const info = await transporter.sendMail(options)
+      logger.info(`${msgType} mail sent successfully: ${info.messageId}`)
+      return info
+    } catch (error: any) {
+      logger.error(`${msgType} failed to send mail: ${error?.message ?? error}`)
+      throw error
+    }
+  }
+}

src/lib/smtp/template/auth.ts

@@ -0,0 +1,68 @@
+import { green } from 'colorette'
+import fs from 'fs'
+import Handlebars from 'handlebars'
+import path from 'path'
+import { env } from '~/config/env'
+import { logger } from '~/config/logger'
+import { smtp } from '~/config/smtp'
+import { readHTMLFile } from '~/lib/fs/read-file'
+import ErrorResponse from '~/lib/http/errors'
+import { currentDir } from '~/lib/string'
+
+/**
+ * Returns the path to the email template
+ * @param htmlPath - the path to the email template
+ * @returns the path to the email template
+ */
+function _emailTemplatePath(htmlPath: string) {
+  const _path = path.resolve(`${currentDir}/public/email-template/${htmlPath}`)
+
+  const msgType = green('email template')
+  logger.info(`${msgType} - ${_path} exists`)
+
+  return _path
+}
+
+/**
+ * Sends an email
+ * @param _path - the path to the email template
+ * @param data - the data to be sent
+ * @returns the email template
+ */
+async function _sendMail(_path: string, data: any) {
+  if (!fs.existsSync(_path)) {
+    throw new ErrorResponse.BadRequest('invalid template path ')
+  }
+
+  const html = await readHTMLFile(_path)
+  const template = Handlebars.compile(html)
+  const htmlToSend = template(data)
+
+  await smtp.send({
+    to: data.email,
+    subject: data.subject,
+    text: data.text,
+    html: htmlToSend,
+  })
+}
+
+type SendEmailRegistrationParams = {
+  fullname: string
+  email: string
+  url_token: string
+}
+
+/**
+ * Sends an email to the user
+ * @param values - the data to be sent
+ */
+export async function SendEmailRegistration(values: SendEmailRegistrationParams) {
+  const _path = _emailTemplatePath('register.html')
+
+  const { fullname, url_token } = values
+  const subject = `${fullname}, Thank you for registering on the ${env.APP_NAME} App`
+  const text = `Please click the link below to verify your email: ${env.APP_URL}/verify/${url_token}`
+
+  const data = { ...values, subject, text, APP_NAME: env.APP_NAME }
+  await _sendMail(_path, data)
+}

src/lib/smtp/types.ts

@@ -0,0 +1,6 @@
+import SMTPTransport from 'nodemailer/lib/smtp-transport'
+
+export type NodemailerParams = {
+  transporter: SMTPTransport | SMTPTransport.Options
+  defaults?: SMTPTransport.Options
+}