medusa-plugin-ses 1.0.2 → 2.0.0

package/.babelrc

@@ -0,0 +1,13 @@
+{
+   "plugins": [
+     "@babel/plugin-proposal-class-properties",
+     "@babel/plugin-transform-instanceof",
+     "@babel/plugin-transform-classes"
+   ],
+   "presets": ["@babel/preset-env"],
+   "env": {
+     "test": {
+       "plugins": ["@babel/plugin-transform-runtime"]
+     }
+   }
+ }

package/README.md

@@ -4,11 +4,11 @@ Notifications plugin for Medusa ecommerce server that sends transactional emails
 
 ## Features
 
-- Uses the email templating features built into AWS SES
+- THERE ARE BREAKING CHANGES IF YOU ARE UPGRADING FROM 1.x to 2.0
+- ~~Uses the email templating features built into AWS SES~~ Changed in version 2.0.  Templates are now stored locally.  See Configuration section below.
 - Templates are based on handlebars, so they are compatible with Sendgrid email templates
-- AWS has no frontend for managing templates like Sendgrid does.  You must use the AWS CLI or a third party template manager.
-- Refer to the AWS documentation at https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_CreateEmailTemplate.html.
-- This plugin does not currently handle email attachments of any sort.  If you have a plugin that adds pdf invoices or other attachments, they will not be sent via this plugin.  This may be added at a later time if the need is there.
+- ~~This plugin does not currently handle email attachments of any sort.  If you have a plugin that adds pdf invoices or other attachments, they will not be sent via this plugin.  This may be added at a later time if the need is there.~~  Support for attachments added in version 2.0.
+- An API endpoint for testing and that can be used with other (non-Medusa) applications is included.  By default, the endpoint does nothing for security reasons.  See configuration options below to enable it.
 
 ## Configuration
 
@@ -21,23 +21,24 @@ Enable in your medusa-config.js file similar to other plugins:
       access_key_id: process.env.SES_ACCESS_KEY_ID,
       secret_access_key: process.env.SES_SECRET_ACCESS_KEY,
       region: process.env.SES_REGION,
-      from: "example@example.com",
-      order_placed_template: "order_placed"
-      //order_return_requested_template: ""
-      //swap_shipment_created_template: ""
-      //claim_shipment_created_template: ""
-      //order_items_returned_template: ""
-      //swap_received_template: ""
-      //swap_created_template: ""
-      //gift_card_created_template: ""
-      //gift_card_created_template: ""
-      //order_shipped_template: ""
-      //order_canceled_template: ""
-      //user_password_reset_template: ""
-      //medusa_restock_template: ""
-      //order_refund_created_template: ""
+      from: process.env.SES_FROM,
+      enable_endpoint: process.env.SES_ENABLE_ENDPOINT,
+      template_path: process.env.SES_TEMPLATE_PATH,
+      order_placed_template: 'order_placed',
+      order_shipped_template: 'order_shipped',
+      user_password_reset_template: 'user_password_reset',
+      gift_card_created_template: 'gift_card_created',
+      //order_canceled_template: 'order_canceled',
+      //order_refund_created_template: 'order_refund_created',
+      //order_return_requested_template: 'order_return_requested',
+      //order_items_returned_template: 'order_items_returned',
+      //swap_created_template: 'swap_created',
+      //swap_shipment_created_template: 'swap_shipment_created',
+      //swap_received_template: 'swap_received',
+      //claim_shipment_created_template: 'claim_shipment_created',
+      //medusa_restock_template: 'medusa_restock',
     }
-  }
+  },
 ```
 
 The credentials and region are pulled from env variables.  
@@ -45,11 +46,49 @@ The credentials and region are pulled from env variables.
 SES_REGION=""
 SES_ACCESS_KEY_ID=""
 SES_SECRET_ACCESS_KEY=""
+SES_FROM="Cool Company <orders@example.com>"
+SES_ENABLE_ENDPOINT=false
+SES_TEMPLATE_PATH="/full/absolute/path/to/medusa-server/data/templates"
 ```
 - SES_REGION will be for example "us-east-1"
-- Obtain the access key and secret access key by creating an IAM user with SES send permissions
 
-The from email address must be a verified sender in your AWS account.
+- Obtain the access key id and secret access key by creating an IAM user with SES send permissions.
+
+- The SES_FROM email address must be a verified sender in your AWS account.
+
+- The template path is the relative path from the medusa-server root folder.  For example, create a 'data/templates' folder and make 'data/templates' the SES_TEMPLATE_PATH variable.
+```
+medusa-server  // root directory
+|-data
+      |-templates
+            |-order_placed  // or whatever you name your templates and specify in the config file
+                  |-subject.hbs
+                  |-html.hbs
+                  |-text.hbs
+            |-gift_card_created
+                  |-subject.hbs
+                  |-html.hbs
+                  |-text.hbs
+            |- etc   
+```
+
+- When emails are sent, each of the three parts will be compiled. 
+* subject is required
+* either html or text is required, but one or the other can be blank.
+- The template reference here explains the variables that can be used: https://docs.medusajs.com/add-plugins/sendgrid/#template-reference
+
+
+- This plugin adds an endpoint at http://[server]/ses/send
+By default, the endpoint will refuse to send any emails.
+This endpoint may be useful for testing purposes and for use by related applications.
+There is NO SECURITY on the endpoint by default.
+Most people will NOT need to enable this endpoint.
+If you are certain that you want to enable it and that you know what you are doing,
+set the environment variable SES_ENABLE_ENDPOINT to "42" (string).
+The unsual setting is meant to prevent enabling by accident or without thought.
+To use the endpoint, POST a json req.body with: template_id, from, to, and data to /ses/send.
+Remember that the from email address must be a verified sender in your AWS console.
+Also remember that if your AWS account is still in sandbox mode, you can only SEND emails to verified sender email addresses.
 
 ## Acknowledgement
 

package/api/index.js

@@ -5,11 +5,32 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _express = require("express");
-var _routes = _interopRequireDefault(require("./routes"));
+var _bodyParser = _interopRequireDefault(require("body-parser"));
+var _medusaCoreUtils = require("medusa-core-utils");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-var _default = function _default(container) {
-  var app = (0, _express.Router)();
-  (0, _routes["default"])(app);
-  return app;
+var router = (0, _express.Router)();
+var _default = function _default(app) {
+  router.use(_bodyParser["default"].json());
+  router.post("/ses/send", function (req, res) {
+    var sesService = req.scope.resolve("sesService");
+    var schema = _medusaCoreUtils.Validator.object().keys({
+      template_id: _medusaCoreUtils.Validator.string().required(),
+      from: _medusaCoreUtils.Validator.string().required(),
+      to: _medusaCoreUtils.Validator.string().required(),
+      data: _medusaCoreUtils.Validator.object().optional()["default"]({})
+    });
+    var _schema$validate = schema.validate(req.body),
+      value = _schema$validate.value,
+      error = _schema$validate.error;
+    if (error) {
+      throw new _medusaCoreUtils.MedusaError(_medusaCoreUtils.MedusaError.Types.INVALID_DATA, error.details);
+    }
+    sesService.sendEmail(value.template_id, value.from, value.to, value.data).then(function (result) {
+      return res.json({
+        result: result
+      });
+    });
+  });
+  return router;
 };
 exports["default"] = _default;

package/jest.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+   testEnvironment: "node",
+}

package/package.json

@@ -1,7 +1,7 @@
 {
    "name": "medusa-plugin-ses",
-   "version": "1.0.2",
-   "description": "AWS SES transactional emails based on medusa-plugin-sendgrid by Oliver Juhl",
+   "version": "2.0.0",
+   "description": "AWS SES transactional emails using local handlebars templates",
    "main": "index.js",
    "repository": {
       "type": "git",
@@ -22,24 +22,28 @@
       "client-sessions": "^0.8.0",
       "cross-env": "^5.2.1",
       "jest": "^25.5.2",
-      "medusa-interfaces": "^1.3.3"
+      "medusa-interfaces": "^1.3.4"
    },
    "scripts": {
-      "build": "babel src -d .",
       "prepare": "cross-env NODE_ENV=production yarn run build",
-      "watch": "babel -w src --out-dir . --ignore **/__tests__",
-      "test": "jest --passWithNoTests"
+      "test": "jest --passWithNoTests src",
+      "build": "babel src --out-dir . --ignore '**/__tests__','**/__mocks__'",
+      "watch": "babel -w src --out-dir . --ignore '**/__tests__','**/__mocks__'"
    },
    "peerDependencies": {
-      "medusa-interfaces": "1.x"
+      "medusa-interfaces": "^1.3.4"
    },
    "dependencies": {
       "@aws-sdk/client-ses": "^3.241.0",
       "@babel/plugin-transform-classes": "^7.9.5",
       "body-parser": "^1.19.0",
       "express": "^4.17.1",
+      "fs": "^0.0.1-security",
+      "handlebars": "^4.7.7",
       "medusa-core-utils": "^1.1.37",
-      "medusa-test-utils": "^1.1.37"
+      "medusa-test-utils": "^1.1.37",
+      "nodemailer": "^6.9.1",
+      "path": "^0.12.7"
    },
    "gitHead": "3bbd1e8507e00bc471de6ae3c30207999a4a4011",
    "keywords": [