server/utils/mail: add types & update to named export

Author: clairep94

server/controllers/user.controller.js

@@ -1,7 +1,7 @@
 import crypto from 'crypto';
 
 import User from '../models/user';
-import mail from '../utils/mail';
+import { mailerService } from '../utils/mail';
 import { renderEmailConfirmation, renderResetPassword } from '../views/mail';
 
 export * from './user.controller/apiKey';
@@ -83,7 +83,7 @@ export async function createUser(req, res) {
       });
 
       try {
-        await mail.send(mailOptions);
+        await mailerService.send(mailOptions);
         res.json(userResponse(user));
       } catch (mailErr) {
         console.error(mailErr);
@@ -155,7 +155,7 @@ export async function resetPasswordInitiate(req, res) {
       to: user.email
     });
 
-    await mail.send(mailOptions);
+    await mailerService.send(mailOptions);
     res.json({
       success: true,
       message:
@@ -203,7 +203,7 @@ export async function emailVerificationInitiate(req, res) {
       to: user.email
     });
     try {
-      await mail.send(mailOptions);
+      await mailerService.send(mailOptions);
     } catch (mailErr) {
       res.status(500).send({ error: 'Error sending mail' });
       return;
@@ -334,7 +334,7 @@ export async function updateSettings(req, res) {
         to: user.email
       });
 
-      await mail.send(mailOptions);
+      await mailerService.send(mailOptions);
     } else {
       await saveUser(res, user);
     }

server/migrations/emailConsolidation.js

@@ -7,7 +7,7 @@ import {
   moveObjectToUserInS3,
   copyObjectInS3
 } from '../controllers/aws.controller';
-import mail from '../utils/mail';
+import { mailerService } from '../utils/mail';
 import { renderAccountConsolidation } from '../views/mail';
 
 const mongoConnectionString = process.env.MONGO_URL;
@@ -31,7 +31,8 @@ mongoose.connection.on('error', () => {
  * https://mongodb.github.io/node-mongodb-native
  */
 
-const agg = [ // eslint-disable-line
+const agg = [
+  // eslint-disable-line
   {
     $project: {
       email: {
@@ -187,7 +188,7 @@ async function consolidateAccount(email) {
       });
 
       return new Promise((resolve, reject) => {
-        mail.send(mailOptions, (mailErr, result) => {
+        mailerService.send(mailOptions, (mailErr, result) => {
           console.log('Sent email.');
           if (mailErr) {
             return reject(mailErr);
@@ -226,7 +227,7 @@ async function consolidateAccount(email) {
 //   });
 
 //   return new Promise((resolve, reject) => {
-//     mail.send(mailOptions, (mailErr, result) => {
+//     mailerService.send(mailOptions, (mailErr, result) => {
 //       console.log('Sent email.');
 //       if (mailErr) {
 //         return reject(mailErr);

server/utils/mail.ts

@@ -1,24 +1,30 @@
-/**
- * Mail service wrapping around mailgun
- */
-
 import nodemailer from 'nodemailer';
 import mg from 'nodemailer-mailgun-transport';
+import { RenderedMailerData } from '../types/email';
+
+if (!process.env.MAILGUN_KEY) {
+  throw new Error('Mailgun key missing');
+}
 
 const auth = {
   api_key: process.env.MAILGUN_KEY,
   domain: process.env.MAILGUN_DOMAIN
 };
 
+/** Mail service class wrapping around mailgun */
 class Mail {
+  client: nodemailer.Transporter;
+
+  sendOptions: Pick<nodemailer.SendMailOptions, 'from'>;
+
   constructor() {
     this.client = nodemailer.createTransport(mg({ auth }));
     this.sendOptions = {
       from: process.env.EMAIL_SENDER
     };
   }
 
-  async sendMail(mailOptions) {
+  async sendMail(mailOptions: nodemailer.SendMailOptions) {
     try {
       const response = await this.client.sendMail(mailOptions);
       return response;
@@ -28,8 +34,8 @@ class Mail {
     }
   }
 
-  async send(data) {
-    const mailOptions = {
+  async send(data: RenderedMailerData) {
+    const mailOptions: nodemailer.SendMailOptions = {
       from: this.sendOptions.from,
       to: data.to,
       subject: data.subject,
@@ -46,4 +52,7 @@ class Mail {
   }
 }
 
-export default new Mail();
+/**
+ * Mail service wrapping around mailgun
+ */
+export const mailerService = new Mail();