@b2y/email-service 1.0.9 → 1.2.0

package/package.json

@@ -1,53 +1,55 @@
-{
-  "name": "@b2y/email-service",
-  "version": "1.0.9",
-  "main": "index.js",
-  "exports": {
-    ".": "./index.js",
-    "./providers": "./providers/index.js",
-    "./providers/base": "./providers/BaseProvider.js",
-    "./providers/nodemailer": "./providers/NodeMailerProvider.js",
-    "./providers/sendgrid": "./providers/SendGridProvider.js",
-    "./utils/templateEngine": "./utils/TemplateEngine.js",
-    "./EmailService": "./service/EmailService.js"
-  },
-  "files": [
-    "providers/",
-    "templates/",
-    "utils/",
-    "constants/",
-    "enum/",
-    "model/",
-    "service/",
-    "*.js"
-  ],
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "start": "node test.js"
-  },
-  "author": "",
-  "license": "ISC",
-  "description": "A flexible email service with support for multiple providers and custom templates",
-  "keywords": [
-    "email",
-    "templates",
-    "nodemailer",
-    "sendgrid"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "dependencies": {
-    "@aws-sdk/client-ses": "^3.957.0",
-    "@sendgrid/mail": "^8.1.5",
-    "b2y-logger": "^1.1.0",
-    "dotenv": "^16.5.0",
-    "handlebars": "^4.7.8",
-    "log4js": "^6.9.1",
-    "nodemailer": "^6.10.0",
-    "pg": "^8.16.3",
-    "pg-hstore": "^2.3.4",
-    "postmark": "^4.0.5",
-    "sequelize": "^6.37.7"
-  }
-}
+{
+  "name": "@b2y/email-service",
+  "version": "1.2.0",
+  "main": "index.js",
+  "exports": {
+    ".": "./index.js",
+    "./providers": "./providers/index.js",
+    "./providers/base": "./providers/BaseProvider.js",
+    "./providers/nodemailer": "./providers/NodeMailerProvider.js",
+    "./providers/sendgrid": "./providers/SendGridProvider.js",
+    "./utils/templateEngine": "./utils/TemplateEngine.js",
+    "./EmailService": "./service/EmailService.js"
+  },
+  "files": [
+    "providers/",
+    "templates/",
+    "utils/",
+    "constants/",
+    "enum/",
+    "model/",
+    "service/",
+    "*.js"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node test.js"
+  },
+  "author": "",
+  "license": "ISC",
+  "description": "A flexible email service with support for multiple providers and custom templates",
+  "keywords": [
+    "email",
+    "templates",
+    "nodemailer",
+    "sendgrid"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@aws-sdk/client-ses": "^3.957.0",
+    "@sendgrid/mail": "^8.1.5",
+    "b2y-logger": "^1.1.0",
+    "dotenv": "^16.5.0",
+    "form-data": "^4.0.5",
+    "handlebars": "^4.7.8",
+    "log4js": "^6.9.1",
+    "mailgun.js": "^12.7.0",
+    "nodemailer": "^6.10.0",
+    "pg": "^8.16.3",
+    "pg-hstore": "^2.3.4",
+    "postmark": "^4.0.5",
+    "sequelize": "^6.37.7"
+  }
+}

package/providers/AmazonSESProvider.js

@@ -1,77 +1,84 @@
-// providers/AmazonSES.js
-const { SESClient, SendEmailCommand } = require('@aws-sdk/client-ses');
-const BaseProvider = require('./BaseProvider');
-const Config = require('../Config');
-const logger = require('../Logger');
-const StatusMessage = require('../constants/StatusMessageConstants');
-const { EmailProvider } = require('../enum/EmailProvider');
-
-class AmazonSESProvider extends BaseProvider {
-  constructor() {
-    super();
-    this.client = new SESClient({
-      region: Config.awsRegion,
-      credentials: {
-        accessKeyId: Config.awsAccessKeyId,
-        secretAccessKey: Config.awsSecretAccessKey
-      }
-    });
-  }
-
-  async sendEmail(options) {
-    try {
-      this.validateEmailOptions(options);
-      
-      const toAddresses = this.formatRecipients(options.to);
-      const ccAddresses = options.cc ? this.formatRecipients(options.cc) : [];
-      const bccAddresses = options.bcc ? this.formatRecipients(options.bcc) : [];
-      
-      const params = {
-        Source: options.from || Config.awsFromEmail,
-        Destination: {
-          ToAddresses: toAddresses,
-          ...(ccAddresses.length > 0 && { CcAddresses: ccAddresses }),
-          ...(bccAddresses.length > 0 && { BccAddresses: bccAddresses })
-        },
-        Message: {
-          Subject: {
-            Data: options.subject,
-            Charset: 'UTF-8'
-          },
-          Body: {
-            Html: {
-              Data: options.html,
-              Charset: 'UTF-8'
-            }
-          }
-        }
-      };
-
-      // Add attachments if present (SES requires using SendRawEmail for attachments)
-      if (options.attachments && options.attachments.length > 0) {
-        logger.warn('SES provider: Attachments require SendRawEmail. Consider implementing raw email support.');
-      }
-
-      const command = new SendEmailCommand(params);
-      const result = await this.client.send(command);
-      
-      logger.info('Email sent successfully via Amazon SES', {
-        messageId: result.MessageId,
-        recipients: { to: options.to, cc: options.cc, bcc: options.bcc },
-        tenantId: options.tenantId
-      });
-      
-      return {
-        success: true,
-        messageId: result.MessageId,
-        provider: EmailProvider.SES,
-        tenantId: options.tenantId
-      };
-    } catch (error) {
-      logger.error(`Amazon SES failed to send email: ${error.message}`);
-      throw new Error(`${StatusMessage.AMAZON_SES_SEND_ERROR}: ${error.message}`);
-    }
-  }
-}
-
+// providers/AmazonSES.js
+const { SESClient, SendEmailCommand } = require('@aws-sdk/client-ses');
+const BaseProvider = require('./BaseProvider');
+const Config = require('../Config');
+const logger = require('../Logger');
+const StatusMessage = require('../constants/StatusMessageConstants');
+const { EmailProvider } = require('../enum/EmailProvider');
+
+class AmazonSESProvider extends BaseProvider {
+  constructor() {
+    super();
+    this.client = new SESClient({
+      region: Config.awsRegion,
+      credentials: {
+        accessKeyId: Config.awsAccessKeyId,
+        secretAccessKey: Config.awsSecretAccessKey
+      }
+    });
+  }
+
+  async sendEmail(options) {
+    try {
+      this.validateEmailOptions(options);
+      
+      const toAddresses = this.formatRecipients(options.to);
+      const ccAddresses = options.cc ? this.formatRecipients(options.cc) : [];
+      const bccAddresses = options.bcc ? this.formatRecipients(options.bcc) : [];
+      
+
+      const fromAddress = this.formatFromAddress(
+        options.from || Config.awsFromEmail,
+        options.fromName || Config.fromName
+      );
+      
+      const params = {
+        Source: fromAddress,
+        Destination: {
+          ToAddresses: toAddresses,
+          ...(ccAddresses.length > 0 && { CcAddresses: ccAddresses }),
+          ...(bccAddresses.length > 0 && { BccAddresses: bccAddresses })
+        },
+        Message: {
+          Subject: {
+            Data: options.subject,
+            Charset: 'UTF-8'
+          },
+          Body: {
+            Html: {
+              Data: options.html,
+              Charset: 'UTF-8'
+            }
+          }
+        }
+      };
+
+      // Add attachments if present (SES requires using SendRawEmail for attachments)
+      if (options.attachments && options.attachments.length > 0) {
+        logger.warn('SES provider: Attachments require SendRawEmail. Consider implementing raw email support.');
+      }
+
+      const command = new SendEmailCommand(params);
+      const result = await this.client.send(command);
+      
+      logger.info('Email sent successfully via Amazon SES', {
+        messageId: result.MessageId,
+        recipients: { to: options.to, cc: options.cc, bcc: options.bcc },
+        tenantId: options.tenantId,
+        from: fromAddress
+      });
+      
+      return {
+        success: true,
+        messageId: result.MessageId,
+        provider: EmailProvider.SES,
+        tenantId: options.tenantId
+      };
+    } catch (error) {
+      logger.error(`Amazon SES failed to send email: ${error.message}`);
+      throw new Error(`${StatusMessage.AMAZON_SES_SEND_ERROR}: ${error.message}`);
+    }
+  }
+}
+
 module.exports = AmazonSESProvider;

package/providers/BaseProvider.js

@@ -1,74 +1,86 @@
-// providers/BaseProvider.js
-const logger = require('../Logger');
-const StatusMessage = require('../constants/StatusMessageConstants');
-class BaseProvider {
-  constructor() {
-    if (new.target === BaseProvider) {
-      throw new Error(StatusMessage.CANNOT_INSTANTIATE_BASE);
-    }
-  }
-
-  async sendEmail(options) {
-    logger.error('sendEmail method not implemented in BaseProvider');
-    throw new Error(StatusMessage.PROVIDER_NOT_IMPLEMENTED);
-  }
-  
-  validateEmailOptions(options) {
-    const { to, subject, html, from } = options;
-    
-    if (!to || (Array.isArray(to) && to.length === 0)) {
-      throw new Error(StatusMessage.RECIPIENTS_REQUIRED);
-    }
-    
-    if (!subject) {
-      throw new Error(StatusMessage.SUBJECT_REQUIRED);
-    }
-    
-    if (!html) {
-      throw new Error(StatusMessage.HTML_CONTENT_REQUIRED);
-    }
-    
-    return true;
-  }
-  
-  formatRecipients(recipients) {
-    if (!recipients) return [];
-    
-    if (typeof recipients === 'string') {
-      return recipients.split(',').map(r => r.trim());
-    }
-    
-    if (Array.isArray(recipients)) {
-      return recipients;
-    }
-    
-    return [];
-  }
-
-  buildMailOptions(options) {
-    const { to, cc, bcc, subject, html, from, attachments } = options;
-    
-    const mailOptions = {
-      from,
-      to: this.formatRecipients(to),
-      subject,
-      html,
-    };
-    
-    if (cc && cc.length > 0) {
-      mailOptions.cc = this.formatRecipients(cc);
-    }
-    
-    if (bcc && bcc.length > 0) {
-      mailOptions.bcc = this.formatRecipients(bcc);
-    }
-    
-    if (attachments && attachments.length > 0) {
-      mailOptions.attachments = attachments;
-    }
-    
-    return mailOptions;
-  }
-}
-
+// providers/BaseProvider.js
+const logger = require('../Logger');
+const StatusMessage = require('../constants/StatusMessageConstants');
+const Config = require('../Config');
+
+class BaseProvider {
+  constructor() {
+    if (new.target === BaseProvider) {
+      throw new Error(StatusMessage.CANNOT_INSTANTIATE_BASE);
+    }
+  }
+
+  async sendEmail(options) {
+    logger.error('sendEmail method not implemented in BaseProvider');
+    throw new Error(StatusMessage.PROVIDER_NOT_IMPLEMENTED);
+  }
+  
+  validateEmailOptions(options) {
+    const { to, subject, html, from } = options;
+    
+    if (!to || (Array.isArray(to) && to.length === 0)) {
+      throw new Error(StatusMessage.RECIPIENTS_REQUIRED);
+    }
+    
+    if (!subject) {
+      throw new Error(StatusMessage.SUBJECT_REQUIRED);
+    }
+    
+    if (!html) {
+      throw new Error(StatusMessage.HTML_CONTENT_REQUIRED);
+    }
+    
+    return true;
+  }
+  
+  formatRecipients(recipients) {
+    if (!recipients) return [];
+    
+    if (typeof recipients === 'string') {
+      return recipients.split(',').map(r => r.trim());
+    }
+    
+    if (Array.isArray(recipients)) {
+      return recipients;
+    }
+    
+    return [];
+  }
+
+  formatFromAddress(email, name = null) {
+    const fromName = name || Config.fromName;
+    const fromEmail = email || Config.fromEmail;
+    
+    if (!fromEmail) {
+      throw new Error('FROM_EMAIL is required');
+    }
+    return fromName ? `"${fromName}" <${fromEmail}>` : fromEmail;
+  }
+
+  buildMailOptions(options) {
+    const { to, cc, bcc, subject, html, from, fromName, attachments } = options;
+    
+    const mailOptions = {
+      from: this.formatFromAddress(from, fromName),
+      to: this.formatRecipients(to),
+      subject,
+      html,
+    };
+    
+    if (cc && cc.length > 0) {
+      mailOptions.cc = this.formatRecipients(cc);
+    }
+    
+    if (bcc && bcc.length > 0) {
+      mailOptions.bcc = this.formatRecipients(bcc);
+    }
+    
+    if (attachments && attachments.length > 0) {
+      mailOptions.attachments = attachments;
+    }
+    
+    return mailOptions;
+  }
+}
+
 module.exports = BaseProvider;

package/providers/MailgunProvider.js

@@ -0,0 +1,85 @@
+// providers/MailgunProvider.js
+const formData = require('form-data');
+const Mailgun = require('mailgun.js');
+const BaseProvider = require('./BaseProvider');
+const Config = require('../Config');
+const logger = require('../Logger');
+const StatusMessage = require('../constants/StatusMessageConstants');
+const { EmailProvider } = require('../enum/EmailProvider');
+const AppConstants = require('../constants/AppConstants');
+class MailgunProvider extends BaseProvider {
+  constructor() {
+    super();
+    
+    if (!Config.mailgunApiKey) {
+      throw new Error('Mailgun API key is required');
+    }
+    
+    if (!Config.mailgunDomain) {
+      throw new Error('Mailgun domain is required');
+    }
+    
+    const mailgun = new Mailgun(formData);
+    this.client = mailgun.client({
+      username: AppConstants.MAILGUN_AUTH_USERNAME,
+      key: Config.mailgunApiKey
+    });
+    this.domain = Config.mailgunDomain;
+  }
+
+  async sendEmail(options) {
+    try {
+      this.validateEmailOptions(options);
+      
+      const messageData = {
+        from: this.formatFromAddress(
+          options.from || Config.fromEmail,
+          options.fromName || Config.fromName
+        ),
+        to: this.formatRecipients(options.to),
+        subject: options.subject,
+        html: options.html
+      };
+      
+      // Add CC if present
+      if (options.cc && options.cc.length > 0) {
+        messageData.cc = this.formatRecipients(options.cc);
+      }
+      
+      // Add BCC if present
+      if (options.bcc && options.bcc.length > 0) {
+        messageData.bcc = this.formatRecipients(options.bcc);
+      }
+      
+      // Add attachments if present
+      if (options.attachments && options.attachments.length > 0) {
+        messageData.attachment = options.attachments.map(att => ({
+          filename: att.filename,
+          data: att.content,
+          contentType: att.contentType
+        }));
+      }
+      
+      const result = await this.client.messages.create(this.domain, messageData);
+      
+      logger.info('Email sent successfully via Mailgun', {
+        messageId: result.id,
+        recipients: { to: options.to, cc: options.cc, bcc: options.bcc },
+        tenantId: options.tenantId,
+        from: messageData.from
+      });
+      
+      return {
+        success: true,
+        messageId: result.id,
+        provider: EmailProvider.MAILGUN,
+        tenantId: options.tenantId
+      };
+    } catch (error) {
+      logger.error('Mailgun failed to send email:', error);
+      throw new Error(StatusMessage.MAILGUN_SEND_ERROR);
+    }
+  }
+}
+
+module.exports = MailgunProvider;

package/providers/NodeMailerProvider.js

@@ -1,52 +1,53 @@
-// providers/NodeMailerProvider.js
-const nodemailer = require('nodemailer');
-const BaseProvider = require('./BaseProvider');
-const Config = require('../Config');
-const logger = require('../Logger');
-const StatusMessage = require('../constants/StatusMessageConstants');
-const { EmailProvider } = require('../enum/EmailProvider');
-
-class NodeMailerProvider extends BaseProvider {
-  constructor() {
-    super();
-    this.transporter = nodemailer.createTransport({ 
-      service: Config.emailService,
-      host: Config.emailHost,
-      port: Config.smtpPort,
-      secure: Config.smtpPort,
-      auth: {
-        user: Config.emailUser,
-        pass: Config.emailPass,
-      },
-    });
-  }
-
-  async sendEmail(options) {
-    try {
-      this.validateEmailOptions(options);
-      const mailOptions = this.buildMailOptions({
-        ...options,
-        from: options.from || Config.emailUser
-      });
-      const result = await this.transporter.sendMail(mailOptions);
-      
-      logger.info('Email sent successfully via Nodemailer', {
-        messageId: result.messageId,
-        recipients: { to: options.to, cc: options.cc, bcc: options.bcc },
-        tenantId: options.tenantId
-      });
-      
-      return {
-        success: true,
-        messageId: result.messageId,
-        provider: EmailProvider.NODE_MAILER,
-        tenantId: options.tenantId
-      };
-    } catch (error) {
-      logger.error(`Nodemailer failed to send email: ${error.message}`);
-      throw new Error(`${StatusMessage.NODEMAILER_SEND_ERROR}: ${error.message}`);
-    }
-  }
-}
-
+// providers/NodeMailerProvider.js
+const nodemailer = require('nodemailer');
+const BaseProvider = require('./BaseProvider');
+const Config = require('../Config');
+const logger = require('../Logger');
+const StatusMessage = require('../constants/StatusMessageConstants');
+const { EmailProvider } = require('../enum/EmailProvider');
+
+class NodeMailerProvider extends BaseProvider {
+  constructor() {
+    super();
+    this.transporter = nodemailer.createTransport({ 
+      host: Config.emailHost,
+      port: Config.smtpPort,
+      secure: Config.smtpPort,
+      auth: {
+        user: Config.emailUser,
+        pass: Config.emailPass,
+      },
+    });
+  }
+
+  async sendEmail(options) {
+    try {
+      this.validateEmailOptions(options);
+      const mailOptions = this.buildMailOptions({
+        ...options,
+        from: options.from || Config.fromEmail,
+        fromName: options.fromName || Config.fromName
+      });
+      const result = await this.transporter.sendMail(mailOptions);
+      
+      logger.info('Email sent successfully via Nodemailer', {
+        messageId: result.messageId,
+        recipients: { to: options.to, cc: options.cc, bcc: options.bcc },
+        tenantId: options.tenantId,
+        from: mailOptions.from
+      });
+      
+      return {
+        success: true,
+        messageId: result.messageId,
+        provider: EmailProvider.NODE_MAILER,
+        tenantId: options.tenantId
+      };
+    } catch (error) {
+      logger.error(`Nodemailer failed to send email: ${error.message}`);
+      throw new Error(`${StatusMessage.NODEMAILER_SEND_ERROR}: ${error.message}`);
+    }
+  }
+}
+
 module.exports = NodeMailerProvider;