@johnmmackey/ms-utils 4.1.0 → 4.2.0

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+## Version 4.2.0
+
+Added a self contained, simpler mail function:
+```
+const awsSendMail = require('@johnmmackey/ms-utils').awsSendMail;
+
+await awsSendMail({
+    from: ...
+    to: ...
+    subject: ...
+    textBody: ...
+    htmlBody: ...
+    replyTo?: ...
+})
+```
+The following environment variables are required:
+* AWS_SES_REGION
+* AWS_SES_ACCESS_KEY_ID
+* AWS_SES_SECRET_ACCESS_KEY
+* AWS_SES_IDENTITY_ARN
+* AWS_SES_FEEDBACK_ADDRESS
+
 ## Version 4.1.0
 Added functionality:
 * uses ```dotenv``` to load a local .env file

package/README.md

@@ -47,7 +47,7 @@ sendmail(
 * uses ```dotenv``` to load a .env file in the current working directory into the environment
 * pushes all items loaded from etcd into the environment.
 
-The order of precedence: .env > etcd > external set environment
+The order of precedence: etcd > .env > external set environment
 
 ## Future
 * Add local queueing for log events when AMQP is not operative.

package/index.js

@@ -4,5 +4,6 @@ const Config = require('./lib/config');
 const winstonMSLoggerFactory = require('./lib/winston-mslogger');
 const Utils = require('./lib/utils');
 const Mailer = require('./lib/mail');
+const awsSendMail = require('./lib/awsSendMail')
 
-module.exports = { Utils, Config, winstonMSLoggerFactory, Mailer };
+module.exports = { Utils, Config, winstonMSLoggerFactory, Mailer, awsSendMail };

package/lib/awsSendMail.js

@@ -0,0 +1,99 @@
+const { SESv2Client, SendEmailCommand } = require("@aws-sdk/client-sesv2");
+
+// Create SES service object.
+
+const awsSendMail = async (m) => {
+  const client = new SESv2Client({
+    region: process.env.AWS_SES_REGION,
+    credentials: ({
+      accessKeyId: process.env.AWS_SES_ACCESS_KEY_ID,
+      secretAccessKey: process.env.AWS_SES_SECRET_ACCESS_KEY,
+    })
+  });
+
+  const input = { // SendEmailRequest
+    FromEmailAddress: m.from,
+    FromEmailAddressIdentityArn: process.env.AWS_SES_IDENTITY_ARN,
+    Destination: { // Destination
+      ToAddresses: m.to instanceof Array ? m.to : [m.to],
+      CcAddresses: [],
+      BccAddresses: [],
+    },
+    ReplyToAddresses: [m.replyTo || m.from],
+    FeedbackForwardingEmailAddress: process.env.AWS_SES_FEEDBACK_ADDRESS,
+    FeedbackForwardingEmailAddressIdentityArn: process.env.AWS_SES_IDENTITY_ARN,
+    Content: { // EmailContent
+      Simple: { // Message
+        Subject: { // Content
+          Data: m.subject,
+          Charset: "UTF-8",
+        },
+        Body: { // Body
+          ...(m.textBody &&
+          {
+            Text: {
+              Data: m.textBody ,
+              Charset: "UTF-8",
+            },
+          }
+          ),
+          ...(m.htmlBody &&
+          {
+            Html: {
+              Data: m.htmlBody, // required
+              Charset: "UTF-8",
+            },
+          }
+          )
+        }
+        /*
+        Headers: [ // MessageHeaderList
+            { // MessageHeader
+                Name: "STRING_VALUE", // required
+                Value: "STRING_VALUE", // required
+            },
+        ],
+        */
+      },
+      /*
+      Raw: { // RawMessage
+        Data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")       // required
+      },
+      Template: { // Template
+        TemplateName: "STRING_VALUE",
+        TemplateArn: "STRING_VALUE",
+        TemplateContent: { // EmailTemplateContent
+          Subject: "STRING_VALUE",
+          Text: "STRING_VALUE",
+          Html: "STRING_VALUE",
+        },
+        TemplateData: "STRING_VALUE",
+        Headers: [
+          {
+            Name: "STRING_VALUE", // required
+            Value: "STRING_VALUE", // required
+          },
+        ],
+      },*/
+    },
+    /*
+    EmailTags: [ // MessageTagList
+      { // MessageTag
+        Name: "STRING_VALUE", // required
+        Value: "STRING_VALUE", // required
+      },
+    ],
+    ConfigurationSetName: "STRING_VALUE",
+    EndpointId: "STRING_VALUE",
+    ListManagementOptions: { // ListManagementOptions
+      ContactListName: "STRING_VALUE", // required
+      TopicName: "STRING_VALUE",
+    },
+    */
+  };
+
+  const command = new SendEmailCommand(input);
+  return await client.send(command);
+}
+
+module.exports = awsSendMail;

package/lib/config.js

@@ -25,14 +25,15 @@ async function tryLoad(serviceName) {
 }
 
 async function load(serviceName) {
-    await Promise.retry(10, tryLoad.bind(this, serviceName), 5000);
-
-    // as a side-effect, load these into process.env
-    dotenv.populate(process.env, config, { override: true });
 
     // load any .env file that may be present into the environment
     dotenv.config({ override: true });
 
+    await Promise.retry(10, tryLoad.bind(this, serviceName), 5000);
+
+    // as a side-effect, load these into process.env
+    dotenv.populate(process.env, config, { override: true });
+    return config;
 }
 
 function get(k) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@johnmmackey/ms-utils",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Utility functions for Microservice Architecture",
   "main": "index.js",
   "scripts": {
@@ -14,9 +14,10 @@
   "license": "ISC",
   "homepage": "https://bitbucket.org/52westlabs/ms-utils#readme",
   "dependencies": {
+    "@aws-sdk/client-sesv2": "^3.758.0",
     "dotenv": "^16.4.7",
     "etcd3": "^1.1.2",
-    "redis": "^4.6.12",
-    "uuid": "^9.0.1"
+    "redis": "^4.7.0",
+    "uuid": "^11.1.0"
   }
 }

package/tests/awsSendMailTest.js

@@ -0,0 +1,36 @@
+const dotenv = require('dotenv');
+const { awsSendMail } = require('../index.js');
+
+dotenv.config();
+
+(async () => {
+    /*
+    await awsSendMail(
+        {
+            from: 'info@countryglen.org',
+            to: [
+                "John Mackey <john.m.mackey@gmail.com>",
+                "johnmmackey@yahoo.ca",
+                "john.m.mackey@countryglen.org"
+            ],
+            subject: "Test",
+            htmlBody: "<em>This</em> is progress...",
+        }
+    );
+    */
+
+    await awsSendMail(
+        {
+            from: 'CG <info@countryglen.org>',
+            to: [
+                "John Mackey <john.m.mackey@gmail.com>",
+                //"John Mackey <john.m.mackeasdfasdfay@gmail.com>",
+            ],
+            replyTo: 'john.mackey@viasat.com',
+            subject: "Test",
+            htmlBody: "<em>This</em> is progress...",
+            textBody: "This is progress...",
+            addTextTimestamp: true
+        }
+    );
+})();