@b2y/email-service 1.0.9 → 1.1.0

package/Config.js

@@ -1,40 +1,41 @@
-// config.js
-require('dotenv').config();
-const Config = {
-  // Email Provider Configuration
-  emailProvider: process.env.EMAIL_PROVIDER,
-  
-  // Nodemailer Configuration
-  emailService: process.env.EMAIL_SERVICE,
-  emailHost: process.env.EMAIL_HOST,
-  smtpPort: process.env.SMTP_PORT,
-  emailUser: process.env.EMAIL_USERNAME,
-  emailPass: process.env.EMAIL_PASSWORD,
-  
-  // SendGrid Configuration
-  sendGridApiKey: process.env.SENDGRID_API_KEY,
-  
-  // Postmark Configuration
-  postmarkApiKey: process.env.POSTMARK_API_KEY,
-  postmarkFromEmail: process.env.POSTMARK_FROM_EMAIL,
-  
-  // Amazon SES Configuration
-  awsRegion: process.env.AWS_REGION,
-  awsAccessKeyId: process.env.AWS_ACCESS_KEY_ID,
-  awsSecretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
-  awsFromEmail: process.env.AWS_FROM_EMAIL,
-  
-  defaultLanguage: process.env.DEFAULT_LANGUAGE,
-  
-  // Database Configuration (if using database for templates)
-  dbHost: process.env.DB_HOST,
-  dbPort: process.env.DB_PORT,
-  dbName: process.env.DB_DATABASE,
-  dbUser: process.env.DB_USER,
-  dbPass: process.env.DB_PASSWORD,
-  dbschema:process.env.DB_SCHEMA,
-  dbssl:process.env.DBSSL,
-  
-};
-
+// config.js
+require('dotenv').config();
+const Config = {
+  // Email Provider Configuration
+  emailProvider: process.env.EMAIL_PROVIDER,
+  fromEmail: process.env.FROM_EMAIL,
+  fromName: process.env.FROM_NAME,
+  
+  // Nodemailer Configuration
+  emailHost: process.env.EMAIL_HOST,
+  smtpPort: process.env.EMAIL_PORT,
+  emailUser: process.env.FROM_EMAIL,
+  emailPass: process.env.EMAIL_PASSWORD,
+  
+  // SendGrid Configuration
+  sendGridApiKey: process.env.ACCESS_KEY,
+  
+  // Postmark Configuration
+  postmarkApiKey: process.env.ACCESS_KEY,
+  postmarkFromEmail: process.env.FROM_EMAIL,
+  
+  // Amazon SES Configuration
+  awsRegion: process.env.REGION,
+  awsAccessKeyId: process.env.ACCESS_KEY,
+  awsSecretAccessKey: process.env.ACCESS_SECRET,
+  awsFromEmail: process.env.FROM_EMAIL,
+  
+  defaultLanguage: process.env.DEFAULT_LANGUAGE,
+  
+  // Database Configuration (if using database for templates)
+  dbHost: process.env.DB_HOST,
+  dbPort: process.env.DB_PORT,
+  dbName: process.env.DB_DATABASE,
+  dbUser: process.env.DB_USER,
+  dbPass: process.env.DB_PASSWORD,
+  dbschema:process.env.DB_SCHEMA,
+  dbssl:process.env.DBSSL,
+  
+};
+
 module.exports = Config;

package/Logger.js

@@ -1,6 +1,6 @@
-require('dotenv').config();
-const { createLogger } = require('b2y-logger');
-
-const logger = createLogger();
-
+require('dotenv').config();
+const { createLogger } = require('b2y-logger');
+
+const logger = createLogger();
+
 module.exports = logger;

package/README.md

@@ -1,18 +1,18 @@
-# email-service
-
-A reusable, flexible Node.js email service supporting multiple providers like **Nodemailer (Gmail)** and **SendGrid**, with support for **dynamic HTML templates** using Handlebars.
-
-# Features
-
-- Common interface for multiple email providers
-- Supports Gmail via Nodemailer and SendGrid (easy to extend more)
-- Handlebars-based HTML templates with variables
-- Easily switch between providers without changing your code
-- Dynamic template loading from the filesystem
-- Configurable via environment variables or direct parameters
-
----
-
-# Installation
-
-npm install @ourgitname/email-service
+# email-service
+
+A reusable, flexible Node.js email service supporting multiple providers like **Nodemailer (Gmail)** and **SendGrid**, with support for **dynamic HTML templates** using Handlebars.
+
+# Features
+
+- Common interface for multiple email providers
+- Supports Gmail via Nodemailer and SendGrid (easy to extend more)
+- Handlebars-based HTML templates with variables
+- Easily switch between providers without changing your code
+- Dynamic template loading from the filesystem
+- Configurable via environment variables or direct parameters
+
+---
+
+# Installation
+
+npm install @ourgitname/email-service

package/constants/StatusMessageConstants.js

@@ -1,39 +1,39 @@
-const StatusMessage = {
-  // Database messages
-  DB_CONNECTION_SUCCESS: 'Database connection has been established successfully.',
-  DB_CONNECTION_FAILED: 'Unable to connect to the database:',
-
-  // Email provider messages
-  PROVIDER_NOT_IMPLEMENTED: 'sendEmail method not implemented in BaseProvider',
-  PROVIDER_DEFAULT_FALLBACK: 'No valid provider specified, defaulting to Nodemailer',
-
-  // Validation messages
-  RECIPIENTS_REQUIRED: 'Recipients (to) are required',
-  SUBJECT_REQUIRED: 'Subject is required',
-  HTML_CONTENT_REQUIRED: 'Email content (html) is required',
-  TENANT_ID_REQUIRED: 'TenantID is required',
-  TEMPLATE_OR_HTML_REQUIRED: 'TemplateName or HTML content is required',
-  LANGCODE_IS_REQUIRED: 'Language code (langCode) is required',
-
-  // Template messages
-  TEMPLATE_NOT_FOUND: 'Template "${templateName}" not found for tenant ${tenantId}',
-  TEMPLATE_FETCH_ERROR: 'Error fetching template from DB: ${errorMessage}',
-  TEMPLATE_COMPILE_ERROR: 'Error compiling template "${templateName}": ${errorMessage}',
-  PLACEHOLDER_REPLACE_ERROR: 'Error replacing placeholders: ${errorMessage}',
-
-  // Email sending messages
-  EMAIL_SENT_SUCCESS: 'Email sent successfully for tenant: ${tenantId}',
-  EMAIL_SEND_FAILED: 'Failed to send email for tenant ${tenantId}: ${errorMessage}',
-  
-  // Service initialization messages
-  PROVIDER_REQUIRED: 'Email provider is required',
-  DB_CLIENT_REQUIRED: 'Database client is required',
-  CANNOT_INSTANTIATE_BASE: 'Cannot instantiate BaseProvider directly',
-
-  NODEMAILER_SEND_ERROR:'Nodemailer failed to send email',
-  POSTMARK_SEND_ERROR:'Postmark failed to send email',
-  SENDGRID_SEND_ERROR:'SendGrid failed to send email',
-  AMAZON_SES_SEND_ERROR: 'Amazon SES failed to send email'
-};
-
+const StatusMessage = {
+  // Database messages
+  DB_CONNECTION_SUCCESS: 'Database connection has been established successfully.',
+  DB_CONNECTION_FAILED: 'Unable to connect to the database:',
+
+  // Email provider messages
+  PROVIDER_NOT_IMPLEMENTED: 'sendEmail method not implemented in BaseProvider',
+  PROVIDER_DEFAULT_FALLBACK: 'No valid provider specified, defaulting to Nodemailer',
+
+  // Validation messages
+  RECIPIENTS_REQUIRED: 'Recipients (to) are required',
+  SUBJECT_REQUIRED: 'Subject is required',
+  HTML_CONTENT_REQUIRED: 'Email content (html) is required',
+  TENANT_ID_REQUIRED: 'TenantID is required',
+  TEMPLATE_OR_HTML_REQUIRED: 'TemplateName or HTML content is required',
+  LANGCODE_IS_REQUIRED: 'Language code (langCode) is required',
+
+  // Template messages
+  TEMPLATE_NOT_FOUND: 'Template "${templateName}" not found for tenant ${tenantId}',
+  TEMPLATE_FETCH_ERROR: 'Error fetching template from DB: ${errorMessage}',
+  TEMPLATE_COMPILE_ERROR: 'Error compiling template "${templateName}": ${errorMessage}',
+  PLACEHOLDER_REPLACE_ERROR: 'Error replacing placeholders: ${errorMessage}',
+
+  // Email sending messages
+  EMAIL_SENT_SUCCESS: 'Email sent successfully for tenant: ${tenantId}',
+  EMAIL_SEND_FAILED: 'Failed to send email for tenant ${tenantId}: ${errorMessage}',
+  
+  // Service initialization messages
+  PROVIDER_REQUIRED: 'Email provider is required',
+  DB_CLIENT_REQUIRED: 'Database client is required',
+  CANNOT_INSTANTIATE_BASE: 'Cannot instantiate BaseProvider directly',
+
+  NODEMAILER_SEND_ERROR:'Nodemailer failed to send email',
+  POSTMARK_SEND_ERROR:'Postmark failed to send email',
+  SENDGRID_SEND_ERROR:'SendGrid failed to send email',
+  AMAZON_SES_SEND_ERROR: 'Amazon SES failed to send email'
+};
+
 module.exports = StatusMessage;

package/enum/EmailProvider.js

@@ -1,8 +1,8 @@
-const EmailProvider = {
-  NODE_MAILER: 'nodemailer',
-  SENDGRID: 'sendgrid',
-  POSTMARK: 'postmark',
-  AMAZON_SES: 'amazonses'
-};
-
+const EmailProvider = {
+  NODE_MAILER: 'nodemailer',
+  SENDGRID: 'sendgrid',
+  POSTMARK: 'postmark',
+  AMAZON_SES: 'amazonses'
+};
+
 module.exports = { EmailProvider };

package/index.js

@@ -1,78 +1,78 @@
-const BaseProvider = require('./providers/BaseProvider');
-const NodeMailerProvider = require('./providers/NodeMailerProvider');
-const SendgridProvider = require('./providers/SendgridProvider');
-const PostmarkProvider = require('./providers/PostmarkProvider');
-const AmazonSesProvider = require('./providers/AmazonSESProvider');
-const TemplateEngine = require('./utils/TemplateEngine');
-const EmailService = require('./service/EmailService');
-const Config = require('./Config');
-const logger = require('./Logger');
-const { sequelize, EmailTemplate } = require('./model/Connect');
-const { EmailProvider } = require('./enum/EmailProvider');
-const StatusMessage = require('./constants/StatusMessageConstants');
-// Initialize database connection
-async function initializeDatabase() {
-  try {
-    await sequelize.authenticate();
-    logger.info(StatusMessage.DB_CONNECTION_SUCCESS);
-    return { EmailTemplate };
-  } catch (error) {
-    logger.error(StatusMessage.DB_CONNECTION_FAILED, error);
-    throw error;
-  }
-}
-
-// Factory function to create email provider
-function createEmailProvider() {
-  const provider = (Config.emailProvider || '').toLowerCase().trim();
-  
-  switch (provider) {
-    case EmailProvider.NODE_MAILER:
-      return new NodeMailerProvider();
-    case EmailProvider.SENDGRID:
-      return new SendgridProvider();
-    case EmailProvider.POSTMARK:
-      return new PostmarkProvider();
-    case EmailProvider.AMAZON_SES:
-      return new AmazonSesProvider();
-    default:
-      logger.warn(StatusMessage.PROVIDER_DEFAULT_FALLBACK);
-      return new NodeMailerProvider();
-  }
-}
-
-// Factory function to create email service
-async function createEmailService(options = {}) {
-  try {
-    const provider = options.provider || createEmailProvider();
-    const dbClient = options.dbClient || await initializeDatabase();
-    
-    return new EmailService(provider, dbClient);
-  } catch (error) {
-    logger.error(`Failed to create email service: ${error.message}`);
-    throw error;
-  }
-}
-
-// Create a singleton instance
-let defaultEmailService;
-async function getEmailService() {
-  if (!defaultEmailService) {
-    defaultEmailService = await createEmailService();
-  }
-  return defaultEmailService;
-}
-
-module.exports = {
-  BaseProvider,
-  NodeMailerProvider,
-  SendgridProvider,
-  PostmarkProvider,
-  AmazonSesProvider,
-  EmailService,
-  TemplateEngine,
-  createEmailProvider,
-  createEmailService,
-  getEmailService,
-  Config
+const BaseProvider = require('./providers/BaseProvider');
+const NodeMailerProvider = require('./providers/NodeMailerProvider');
+const SendgridProvider = require('./providers/SendgridProvider');
+const PostmarkProvider = require('./providers/PostmarkProvider');
+const AmazonSesProvider = require('./providers/AmazonSESProvider');
+const TemplateEngine = require('./utils/TemplateEngine');
+const EmailService = require('./service/EmailService');
+const Config = require('./Config');
+const logger = require('./Logger');
+const { sequelize, EmailTemplate } = require('./model/Connect');
+const { EmailProvider } = require('./enum/EmailProvider');
+const StatusMessage = require('./constants/StatusMessageConstants');
+// Initialize database connection
+async function initializeDatabase() {
+  try {
+    await sequelize.authenticate();
+    logger.info(StatusMessage.DB_CONNECTION_SUCCESS);
+    return { EmailTemplate };
+  } catch (error) {
+    logger.error(StatusMessage.DB_CONNECTION_FAILED, error);
+    throw error;
+  }
+}
+
+// Factory function to create email provider
+function createEmailProvider() {
+  const provider = (Config.emailProvider || '').toLowerCase().trim();
+  
+  switch (provider) {
+    case EmailProvider.NODE_MAILER:
+      return new NodeMailerProvider();
+    case EmailProvider.SENDGRID:
+      return new SendgridProvider();
+    case EmailProvider.POSTMARK:
+      return new PostmarkProvider();
+    case EmailProvider.AMAZON_SES:
+      return new AmazonSesProvider();
+    default:
+      logger.warn(StatusMessage.PROVIDER_DEFAULT_FALLBACK);
+      return new NodeMailerProvider();
+  }
+}
+
+// Factory function to create email service
+async function createEmailService(options = {}) {
+  try {
+    const provider = options.provider || createEmailProvider();
+    const dbClient = options.dbClient || await initializeDatabase();
+    
+    return new EmailService(provider, dbClient);
+  } catch (error) {
+    logger.error(`Failed to create email service: ${error.message}`);
+    throw error;
+  }
+}
+
+// Create a singleton instance
+let defaultEmailService;
+async function getEmailService() {
+  if (!defaultEmailService) {
+    defaultEmailService = await createEmailService();
+  }
+  return defaultEmailService;
+}
+
+module.exports = {
+  BaseProvider,
+  NodeMailerProvider,
+  SendgridProvider,
+  PostmarkProvider,
+  AmazonSesProvider,
+  EmailService,
+  TemplateEngine,
+  createEmailProvider,
+  createEmailService,
+  getEmailService,
+  Config
 };

package/model/Connect.js

@@ -1,24 +1,24 @@
-const { Sequelize } = require('sequelize');
-const Config = require('../Config');
-
-const sequelize = new Sequelize({
-  database: Config.dbName,
-  username: Config.dbUser,
-  password: Config.dbPass,
-  host: Config.dbHost,
-  port: Config.dbPort,
-  dialect: 'postgres',
-  schema: Config.dbschema,
-  logging: false,
-  define: {
-    timestamps: false,
-    freezeTableName: true
-  }
-});
-
-const EmailTemplate = require('./EmailTemplate')(sequelize);
-
-module.exports = {
-  sequelize,
-  EmailTemplate
+const { Sequelize } = require('sequelize');
+const Config = require('../Config');
+
+const sequelize = new Sequelize({
+  database: Config.dbName,
+  username: Config.dbUser,
+  password: Config.dbPass,
+  host: Config.dbHost,
+  port: Config.dbPort,
+  dialect: 'postgres',
+  schema: Config.dbschema,
+  logging: false,
+  define: {
+    timestamps: false,
+    freezeTableName: true
+  }
+});
+
+const EmailTemplate = require('./EmailTemplate')(sequelize);
+
+module.exports = {
+  sequelize,
+  EmailTemplate
 };

package/model/EmailTemplate.js

@@ -1,51 +1,51 @@
-const { DataTypes } = require('sequelize');
-require('dotenv').config();
-
-module.exports = (sequelize) => {
-  return sequelize.define('EmailTemplate', {
-    TemplateID: {
-      type: DataTypes.INTEGER,
-      autoIncrement: true,
-      primaryKey: true,
-    },
-    TemplateName: {
-      type: DataTypes.STRING(100),
-      allowNull: false,
-      unique: true,
-    },
-    TenantID: {
-      type: DataTypes.INTEGER,
-      allowNull: false
-    },
-    LangCode: {
-      type: DataTypes.STRING(10),
-      allowNull: false,
-      defaultValue: 'en',
-    },
-    Subject: {
-      type: DataTypes.STRING(255),
-      allowNull: false,
-    },
-    Body: {
-      type: DataTypes.TEXT, 
-      allowNull: false,
-    },
-    CreatedBy: {
-      type: DataTypes.STRING,
-    },
-    CreatedAt: {
-      type: DataTypes.DATE,
-      defaultValue: DataTypes.NOW,
-    },
-    UpdatedBy: {
-      type: DataTypes.STRING,
-    },
-    UpdatedAt: {
-      type: DataTypes.DATE,
-      defaultValue: DataTypes.NOW,
-    }
-  }, {
-    tableName: 'EmailTemplate',
-    timestamps: false,
-  });
-};
+const { DataTypes } = require('sequelize');
+require('dotenv').config();
+
+module.exports = (sequelize) => {
+  return sequelize.define('EmailTemplate', {
+    TemplateID: {
+      type: DataTypes.INTEGER,
+      autoIncrement: true,
+      primaryKey: true,
+    },
+    TemplateName: {
+      type: DataTypes.STRING(100),
+      allowNull: false,
+      unique: true,
+    },
+    TenantID: {
+      type: DataTypes.INTEGER,
+      allowNull: false
+    },
+    LangCode: {
+      type: DataTypes.STRING(10),
+      allowNull: false,
+      defaultValue: 'en',
+    },
+    Subject: {
+      type: DataTypes.STRING(255),
+      allowNull: false,
+    },
+    Body: {
+      type: DataTypes.TEXT, 
+      allowNull: false,
+    },
+    CreatedBy: {
+      type: DataTypes.STRING,
+    },
+    CreatedAt: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+    },
+    UpdatedBy: {
+      type: DataTypes.STRING,
+    },
+    UpdatedAt: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+    }
+  }, {
+    tableName: 'EmailTemplate',
+    timestamps: false,
+  });
+};

package/package.json

@@ -1,53 +1,53 @@
-{
-  "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.1.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",
+    "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"
+  }
+}