medusa-plugin-ses 2.0.6 → 2.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/LICENSE +21 -0
  3. package/README.md +46 -21
  4. package/api/index.js +16 -11
  5. package/index.js +50 -0
  6. package/package.json +6 -5
  7. package/services/ses.js +289 -288
package/CHANGELOG.md ADDED
@@ -0,0 +1,9 @@
1
+ # Change Log
2
+
3
+ ## 2.0.8
4
+
5
+ ### Patch Changes
6
+
7
+ - Added CHANGELOG
8
+ - The template path option can now be absolute or relative to the Medusa root folder
9
+ - No error will be thrown if html.hbs or text.hbs does not exist, so long as the other exists.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 Lacey Pevey
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -2,19 +2,33 @@
2
2
 
3
3
  Notifications plugin for Medusa ecommerce server that sends transactional emails via AWS SES (Simple Email Service).
4
4
 
5
+ [Documentation](https://pevey.com/medusa-plugin-ses)
6
+
7
+ If you are not familiar with Medusa, you can learn more on [the project web site](https://www.medusajs.com/).
8
+
9
+ > Medusa is a set of commerce modules and tools that allow you to build rich, reliable, and performant commerce applications without reinventing core commerce logic. The modules can be customized and used to build advanced ecommerce stores, marketplaces, or any product that needs foundational commerce primitives. All modules are open-source and freely available on npm.
10
+
5
11
  ## Features
6
12
 
7
- - THERE ARE BREAKING CHANGES IF YOU ARE UPGRADING FROM 1.x to 2.0
8
- - ~~Uses the email templating features built into AWS SES~~ Changed in version 2.0. Templates are now stored locally. See Configuration section below.
13
+ - Templates are stored locally.
9
14
  - Templates are based on handlebars, so they are compatible with Sendgrid email templates
10
- - ~~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.
11
- - 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.
15
+ - You can refer to the Medusa template reference to see all data fields that are available for each event: [Template Reference](https://docs.medusajs.com/plugins/notifications/sendgrid#template-reference)
16
+ - An API endpoint that is useful for testing and that can be used with other (non-Medusa) portions of your storefront application is included. By default, the endpoint does nothing for security reasons. See configuration options below to enable it.
17
+
18
+ ## Changes in 2.0.8
19
+
20
+ - The template path option can now be absolute or relative to the Medusa root folder
21
+ - No error will be thrown if html.hbs or text.hbs does not exist, so long as the other exists.
22
+
23
+ ## Node v20
24
+
25
+ - If you are starting to test out Node v20, be sure you give runtime permission for fs reads due to the new Node permissions API. Otherwise, this plugin will not be able to read your email templates from the file system.
12
26
 
13
27
  ## Configuration
14
28
 
15
29
  Enable in your medusa-config.js file similar to other plugins:
16
30
 
17
- ```
31
+ ```bash
18
32
  {
19
33
  resolve: `medusa-plugin-ses`,
20
34
  options: {
@@ -41,23 +55,33 @@ Enable in your medusa-config.js file similar to other plugins:
41
55
  },
42
56
  ```
43
57
 
44
- The credentials and region are pulled from env variables.
45
- ```
58
+ The credentials and region are pulled from env variables.
59
+
60
+ ```bash
46
61
  SES_REGION=""
47
62
  SES_ACCESS_KEY_ID=""
48
63
  SES_SECRET_ACCESS_KEY=""
49
64
  SES_FROM="Cool Company <orders@example.com>"
50
65
  SES_ENABLE_ENDPOINT=false
51
- SES_TEMPLATE_PATH="/full/absolute/path/to/medusa-server/data/templates"
66
+ SES_TEMPLATE_PATH="data/templates"
52
67
  ```
68
+
53
69
  - SES_REGION will be for example "us-east-1"
54
70
 
55
71
  - Obtain the access key id and secret access key by creating an IAM user with SES send permissions.
56
72
 
57
73
  - The SES_FROM email address must be a verified sender in your AWS account.
58
74
 
59
- - The template path must be the full absolute path to the folder. For example, if your build runs from /home/medusa/medusa-server/, create a 'data/templates' folder and include the entire path in the SES_TEMPLATE_PATH variable.
60
- ```
75
+ - From version 2.0.8 and on, SES_TEMPLATE_PATH can be absolute (starting with '/', e.g., '/home/pevey/www/medusa/data/templates') or relative (e.g., 'data/templates')
76
+
77
+ Remember that the from email address must be a verified sender in your AWS console.
78
+ Also remember that if your AWS account is still in sandbox mode, you can only SEND emails to verified sender email addresses.
79
+
80
+ ## Templates
81
+
82
+ The template path must be the full absolute path to the folder. For example, if your build runs from /home/medusa/medusa-server/, create a 'data/templates' folder and include the entire path in the SES_TEMPLATE_PATH variable.
83
+
84
+ ```bash
61
85
  medusa-server // root directory
62
86
  |-data
63
87
  |-templates
@@ -72,24 +96,25 @@ medusa-server // root directory
72
96
  |- etc
73
97
  ```
74
98
 
75
- - When emails are sent, each of the three parts will be compiled.
76
- * subject is required
77
- * either html or text is required, but one or the other can be blank.
78
- - The template reference here explains the variables that can be used: https://docs.medusajs.com/add-plugins/sendgrid/#template-reference
99
+ When emails are sent, each of the three parts will be compiled.
79
100
 
101
+ - Subject is required
102
+ - Either html or text is required, but one or the other can be blank.
103
+ - From version 2.0.8 on, if either the html.hbs or text.hbs does not exist, no error will be thrown so long as the other exists.
104
+
105
+ ## Testing
106
+
107
+ This plugin adds an endpoint at http://[server]/ses/send
80
108
 
81
- - This plugin adds an endpoint at http://[server]/ses/send
82
109
  By default, the endpoint will refuse to send any emails.
83
- This endpoint may be useful for testing purposes and for use by related applications.
84
- There is NO SECURITY on the endpoint by default.
85
- Most people will NOT need to enable this endpoint.
110
+ This endpoint may be useful for testing purposes in a development environment or for use by related applications.
111
+
112
+ There is NO SECURITY on the endpoint by default. Most people will NOT need to enable this endpoint.
86
113
  If you are certain that you want to enable it and that you know what you are doing,
87
114
  set the environment variable SES_ENABLE_ENDPOINT to "42" (string).
88
115
  The unsual setting is meant to prevent enabling by accident or without thought.
89
116
  To use the endpoint, POST a json req.body with: template_id, from, to, and data to /ses/send.
90
- Remember that the from email address must be a verified sender in your AWS console.
91
- Also remember that if your AWS account is still in sandbox mode, you can only SEND emails to verified sender email addresses.
92
117
 
93
118
  ## Acknowledgement
94
119
 
95
- This plugin borrows extensively from medusa-plugin-sendgrid by Oliver Juhl.
120
+ This plugin borrows extensively from medusa-plugin-sendgrid by Oliver Juhl.
package/api/index.js CHANGED
@@ -7,25 +7,30 @@ exports["default"] = void 0;
7
7
  var _express = require("express");
8
8
  var _bodyParser = _interopRequireDefault(require("body-parser"));
9
9
  var _medusaCoreUtils = require("medusa-core-utils");
10
+ var _zod = require("zod");
10
11
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
11
12
  var router = (0, _express.Router)();
12
13
  var _default = function _default(app) {
13
14
  router.use(_bodyParser["default"].json());
14
15
  router.post("/ses/send", function (req, res) {
15
16
  var sesService = req.scope.resolve("sesService");
16
- var schema = _medusaCoreUtils.Validator.object().keys({
17
- template_id: _medusaCoreUtils.Validator.string().required(),
18
- from: _medusaCoreUtils.Validator.string().required(),
19
- to: _medusaCoreUtils.Validator.string().required(),
20
- data: _medusaCoreUtils.Validator.object().optional()["default"]({})
17
+ var schema = _zod.z.object({
18
+ template_id: _zod.z.string().min(1),
19
+ from: _zod.z.string().min(1),
20
+ to: _zod.z.string().min(1),
21
+ data: _zod.z.object({}).required()["default"]({})
21
22
  });
22
- var _schema$validate = schema.validate(req.body),
23
- value = _schema$validate.value,
24
- error = _schema$validate.error;
25
- if (error) {
26
- throw new _medusaCoreUtils.MedusaError(_medusaCoreUtils.MedusaError.Types.INVALID_DATA, error.details);
23
+ var _schema$safeParse = schema.safeParse(req.body),
24
+ success = _schema$safeParse.success,
25
+ error = _schema$safeParse.error,
26
+ data = _schema$safeParse.data;
27
+ if (!success) {
28
+ throw new _medusaCoreUtils.MedusaError(_medusaCoreUtils.MedusaError.Types.INVALID_DATA, error);
27
29
  }
28
- sesService.sendEmail(value.template_id, value.from, value.to, value.data).then(function (result) {
30
+
31
+ //return res.json(data)
32
+
33
+ sesService.sendEmail(data.template_id, data.from, data.to, data.data).then(function (result) {
29
34
  return res.json({
30
35
  result: result
31
36
  });
package/index.js CHANGED
@@ -0,0 +1,50 @@
1
+ const express = require("express")
2
+ const { GracefulShutdownServer } = require("medusa-core-utils")
3
+
4
+ const loaders = require("@medusajs/medusa/dist/loaders/index").default
5
+
6
+ ;(async() => {
7
+ async function start() {
8
+ const app = express()
9
+ const directory = process.cwd()
10
+
11
+ try {
12
+ const { container } = await loaders({
13
+ directory,
14
+ expressApp: app
15
+ })
16
+ const configModule = container.resolve("configModule")
17
+ const port = process.env.PORT ?? configModule.projectConfig.port ?? 9000
18
+
19
+ const server = GracefulShutdownServer.create(
20
+ app.listen(port, (err) => {
21
+ if (err) {
22
+ return
23
+ }
24
+ console.log(`Server is ready on port: ${port}`)
25
+ })
26
+ )
27
+
28
+ // Handle graceful shutdown
29
+ const gracefulShutDown = () => {
30
+ server
31
+ .shutdown()
32
+ .then(() => {
33
+ console.info("Gracefully stopping the server.")
34
+ process.exit(0)
35
+ })
36
+ .catch((e) => {
37
+ console.error("Error received when shutting down the server.", e)
38
+ process.exit(1)
39
+ })
40
+ }
41
+ process.on("SIGTERM", gracefulShutDown)
42
+ process.on("SIGINT", gracefulShutDown)
43
+ } catch (err) {
44
+ console.error("Error starting server", err)
45
+ process.exit(1)
46
+ }
47
+ }
48
+
49
+ await start()
50
+ })()
package/package.json CHANGED
@@ -1,12 +1,13 @@
1
1
  {
2
2
  "name": "medusa-plugin-ses",
3
- "version": "2.0.6",
3
+ "version": "2.0.8",
4
4
  "description": "AWS SES transactional emails using local handlebars templates",
5
5
  "main": "index.js",
6
6
  "repository": {
7
7
  "type": "git",
8
8
  "url": "https://github.com/pevey/medusa-plugin-ses"
9
9
  },
10
+ "homepage:": "https://pevey.com/medusa-plugin-ses",
10
11
  "author": "Lacey Pevey",
11
12
  "license": "MIT",
12
13
  "devDependencies": {
@@ -19,13 +20,12 @@
19
20
  "@babel/preset-env": "^7.7.5",
20
21
  "@babel/register": "^7.7.4",
21
22
  "@babel/runtime": "^7.9.6",
23
+ "awilix": "^8.0.0",
22
24
  "client-sessions": "^0.8.0",
23
25
  "cross-env": "^5.2.1",
24
26
  "jest": "^25.5.2",
25
- "medusa-interfaces": "^1.3.7",
26
27
  "medusa-core-utils": "^1.2.0",
27
- "medusa-test-utils": "^1.1.40",
28
- "awilix": "^8.0.0"
28
+ "medusa-test-utils": "^1.1.40"
29
29
  },
30
30
  "scripts": {
31
31
  "prepare": "cross-env NODE_ENV=production yarn run build",
@@ -45,7 +45,8 @@
45
45
  "fs": "^0.0.1-security",
46
46
  "handlebars": "^4.7.7",
47
47
  "nodemailer": "^6.9.1",
48
- "path": "^0.12.7"
48
+ "path": "^0.12.7",
49
+ "zod": "^3.21.4"
49
50
  },
50
51
  "gitHead": "3bbd1e8507e00bc471de6ae3c30207999a4a4011",
51
52
  "keywords": [
package/services/ses.js CHANGED
@@ -38,18 +38,18 @@ var SESService = /*#__PURE__*/function (_NotificationService) {
38
38
  _inherits(SESService, _NotificationService);
39
39
  var _super = _createSuper(SESService);
40
40
  /**
41
- * @param {Object} options - options defined in `medusa-config.js`
42
- * e.g.
43
- * {
44
- * access_key_id: process.env.SES_ACCESS_KEY_ID,
45
- * secret_access_key: process.env.SES_SECRET_ACCESS_KEY,
46
- * region: process.env.SES_REGION,
47
- * from: process.env.SES_FROM,
48
- * enable_endpoint: process.env.SES_ENABLE_ENDPOINT,
49
- * template_path: process.env.SES_TEMPLATE_PATH,
50
- * order_placed_template: 'order_placed',
51
- * }
52
- */
41
+ * @param {Object} options - options defined in `medusa-config.js`
42
+ * e.g.
43
+ * {
44
+ * access_key_id: process.env.SES_ACCESS_KEY_ID,
45
+ * secret_access_key: process.env.SES_SECRET_ACCESS_KEY,
46
+ * region: process.env.SES_REGION,
47
+ * from: process.env.SES_FROM,
48
+ * enable_endpoint: process.env.SES_ENABLE_ENDPOINT,
49
+ * template_path: process.env.SES_TEMPLATE_PATH,
50
+ * order_placed_template: 'order_placed',
51
+ * }
52
+ */
53
53
  function SESService(_ref, options) {
54
54
  var _this;
55
55
  var storeService = _ref.storeService,
@@ -93,119 +93,231 @@ var SESService = /*#__PURE__*/function (_NotificationService) {
93
93
  return _this;
94
94
  }
95
95
  _createClass(SESService, [{
96
- key: "fetchAttachments",
96
+ key: "sendNotification",
97
97
  value: function () {
98
- var _fetchAttachments = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(event, data, attachmentGenerator) {
99
- var attachments, _data$return_request, shipping_method, shipping_data, provider, lbl, base64;
98
+ var _sendNotification = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(event, eventData, attachmentGenerator) {
99
+ var templateId, data, _yield$this$compileTe, subject, html, text, sendOptions, attachments, status;
100
100
  return _regeneratorRuntime().wrap(function _callee$(_context) {
101
101
  while (1) switch (_context.prev = _context.next) {
102
102
  case 0:
103
- _context.t0 = event;
104
- _context.next = _context.t0 === "swap.created" ? 3 : _context.t0 === "order.return_requested" ? 3 : 17;
105
- break;
103
+ templateId = this.getTemplateId(event);
104
+ if (templateId) {
105
+ _context.next = 3;
106
+ break;
107
+ }
108
+ return _context.abrupt("return", false);
106
109
  case 3:
107
- attachments = [];
108
- _data$return_request = data.return_request, shipping_method = _data$return_request.shipping_method, shipping_data = _data$return_request.shipping_data;
109
- if (!shipping_method) {
110
- _context.next = 11;
110
+ _context.next = 5;
111
+ return this.fetchData(event, eventData, attachmentGenerator);
112
+ case 5:
113
+ data = _context.sent;
114
+ if (data) {
115
+ _context.next = 8;
111
116
  break;
112
117
  }
113
- provider = shipping_method.shipping_option.provider_id;
114
- _context.next = 9;
115
- return this.fulfillmentProviderService_.retrieveDocuments(provider, shipping_data, "label");
116
- case 9:
117
- lbl = _context.sent;
118
- attachments = attachments.concat(lbl.map(function (d) {
119
- return {
120
- name: "return-label",
121
- base64: d.base_64,
122
- type: d.type
123
- };
124
- }));
118
+ return _context.abrupt("return", false);
119
+ case 8:
120
+ if (data.locale) {
121
+ templateId = this.getLocalizedTemplateId(event, data.locale) || templateId;
122
+ }
123
+ _context.next = 11;
124
+ return this.compileTemplate(templateId, data);
125
125
  case 11:
126
- if (!(attachmentGenerator && attachmentGenerator.createReturnInvoice)) {
127
- _context.next = 16;
126
+ _yield$this$compileTe = _context.sent;
127
+ subject = _yield$this$compileTe.subject;
128
+ html = _yield$this$compileTe.html;
129
+ text = _yield$this$compileTe.text;
130
+ if (!(!subject || !html && !text)) {
131
+ _context.next = 17;
128
132
  break;
129
133
  }
130
- _context.next = 14;
131
- return attachmentGenerator.createReturnInvoice(data.order, data.return_request.items);
132
- case 14:
133
- base64 = _context.sent;
134
- attachments.push({
135
- name: "invoice",
136
- base64: base64,
137
- type: "application/pdf"
138
- });
139
- case 16:
140
- return _context.abrupt("return", attachments);
134
+ return _context.abrupt("return", false);
141
135
  case 17:
142
- return _context.abrupt("return", []);
143
- case 18:
136
+ sendOptions = {
137
+ from: this.options_.from,
138
+ to: data.email,
139
+ subject: subject,
140
+ html: html,
141
+ text: text
142
+ };
143
+ _context.next = 20;
144
+ return this.fetchAttachments(event, data, attachmentGenerator);
145
+ case 20:
146
+ attachments = _context.sent;
147
+ if (attachments !== null && attachments !== void 0 && attachments.length) {
148
+ sendOptions.attachments = attachments.map(function (a) {
149
+ return {
150
+ content: a.base64,
151
+ filename: a.name,
152
+ encoding: 'base64',
153
+ contentType: a.type
154
+ };
155
+ });
156
+ }
157
+
158
+ //const status = await this.transporter_.sendMail(sendOptions).then(() => "sent").catch(() => "failed")
159
+ _context.next = 24;
160
+ return this.transporter_.sendMail(sendOptions).then(function () {
161
+ status = "sent";
162
+ })["catch"](function (error) {
163
+ status = "failed";
164
+ console.log(error);
165
+ });
166
+ case 24:
167
+ // We don't want heavy docs stored in DB
168
+ delete sendOptions.attachments;
169
+ return _context.abrupt("return", {
170
+ to: data.email,
171
+ status: status,
172
+ data: sendOptions
173
+ });
174
+ case 26:
144
175
  case "end":
145
176
  return _context.stop();
146
177
  }
147
178
  }, _callee, this);
148
179
  }));
149
- function fetchAttachments(_x, _x2, _x3) {
150
- return _fetchAttachments.apply(this, arguments);
180
+ function sendNotification(_x, _x2, _x3) {
181
+ return _sendNotification.apply(this, arguments);
151
182
  }
152
- return fetchAttachments;
183
+ return sendNotification;
153
184
  }()
154
185
  }, {
155
- key: "fetchData",
186
+ key: "resendNotification",
156
187
  value: function () {
157
- var _fetchData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(event, eventData, attachmentGenerator) {
188
+ var _resendNotification = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(notification, config, attachmentGenerator) {
189
+ var sendOptions, attachs, status;
158
190
  return _regeneratorRuntime().wrap(function _callee2$(_context2) {
159
191
  while (1) switch (_context2.prev = _context2.next) {
160
192
  case 0:
161
- _context2.t0 = event;
162
- _context2.next = _context2.t0 === "order.return_requested" ? 3 : _context2.t0 === "swap.shipment_created" ? 4 : _context2.t0 === "claim.shipment_created" ? 5 : _context2.t0 === "order.items_returned" ? 6 : _context2.t0 === "swap.received" ? 7 : _context2.t0 === "swap.created" ? 8 : _context2.t0 === "gift_card.created" ? 9 : _context2.t0 === "order.gift_card_created" ? 10 : _context2.t0 === "order.placed" ? 11 : _context2.t0 === "order.shipment_created" ? 12 : _context2.t0 === "order.canceled" ? 13 : _context2.t0 === "user.password_reset" ? 14 : _context2.t0 === "customer.password_reset" ? 15 : _context2.t0 === "restock-notification.restocked" ? 16 : _context2.t0 === "order.refund_created" ? 19 : 20;
163
- break;
193
+ sendOptions = _objectSpread(_objectSpread({}, notification.data), {}, {
194
+ to: config.to || notification.to
195
+ });
196
+ _context2.next = 3;
197
+ return this.fetchAttachments(notification.event_name, notification.data.dynamic_template_data, attachmentGenerator);
164
198
  case 3:
165
- return _context2.abrupt("return", this.returnRequestedData(eventData, attachmentGenerator));
166
- case 4:
167
- return _context2.abrupt("return", this.swapShipmentCreatedData(eventData, attachmentGenerator));
168
- case 5:
169
- return _context2.abrupt("return", this.claimShipmentCreatedData(eventData, attachmentGenerator));
170
- case 6:
171
- return _context2.abrupt("return", this.itemsReturnedData(eventData, attachmentGenerator));
199
+ attachs = _context2.sent;
200
+ sendOptions.attachments = attachs.map(function (a) {
201
+ return {
202
+ content: a.base64,
203
+ filename: a.name,
204
+ encoding: 'base64',
205
+ contentType: a.type
206
+ };
207
+ });
208
+
209
+ //const status = await this.transporter_.sendMail(sendOptions).then(() => "sent").catch(() => "failed")
210
+ _context2.next = 7;
211
+ return this.transporter_.sendMail(sendOptions).then(function () {
212
+ status = "sent";
213
+ })["catch"](function (error) {
214
+ status = "failed";
215
+ console.log(error);
216
+ });
172
217
  case 7:
173
- return _context2.abrupt("return", this.swapReceivedData(eventData, attachmentGenerator));
218
+ return _context2.abrupt("return", {
219
+ to: sendOptions.to,
220
+ status: status,
221
+ data: sendOptions
222
+ });
174
223
  case 8:
175
- return _context2.abrupt("return", this.swapCreatedData(eventData, attachmentGenerator));
176
- case 9:
177
- return _context2.abrupt("return", this.gcCreatedData(eventData, attachmentGenerator));
178
- case 10:
179
- return _context2.abrupt("return", this.gcCreatedData(eventData, attachmentGenerator));
180
- case 11:
181
- return _context2.abrupt("return", this.orderPlacedData(eventData, attachmentGenerator));
182
- case 12:
183
- return _context2.abrupt("return", this.orderShipmentCreatedData(eventData, attachmentGenerator));
184
- case 13:
185
- return _context2.abrupt("return", this.orderCanceledData(eventData, attachmentGenerator));
186
- case 14:
187
- return _context2.abrupt("return", this.userPasswordResetData(eventData, attachmentGenerator));
188
- case 15:
189
- return _context2.abrupt("return", this.customerPasswordResetData(eventData, attachmentGenerator));
190
- case 16:
191
- _context2.next = 18;
192
- return this.restockNotificationData(eventData, attachmentGenerator);
193
- case 18:
194
- return _context2.abrupt("return", _context2.sent);
195
- case 19:
196
- return _context2.abrupt("return", this.orderRefundCreatedData(eventData, attachmentGenerator));
197
- case 20:
198
- return _context2.abrupt("return", {});
199
- case 21:
200
224
  case "end":
201
225
  return _context2.stop();
202
226
  }
203
227
  }, _callee2, this);
204
228
  }));
205
- function fetchData(_x4, _x5, _x6) {
206
- return _fetchData.apply(this, arguments);
229
+ function resendNotification(_x4, _x5, _x6) {
230
+ return _resendNotification.apply(this, arguments);
207
231
  }
208
- return fetchData;
232
+ return resendNotification;
233
+ }()
234
+ /**
235
+ * Sends an email using SES.
236
+ * @param {string} template_id - id of template to use
237
+ * @param {string} from - sender of email
238
+ * @param {string} to - receiver of email
239
+ * @param {Object} data - data to send in mail (match with template)
240
+ * @return {Promise} result of the send operation
241
+ */
242
+ }, {
243
+ key: "sendEmail",
244
+ value: function () {
245
+ var _sendEmail = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(template_id, from, to, data) {
246
+ var _yield$this$compileTe2, subject, html, text;
247
+ return _regeneratorRuntime().wrap(function _callee3$(_context3) {
248
+ while (1) switch (_context3.prev = _context3.next) {
249
+ case 0:
250
+ if (!(this.options_.enable_endpoint !== '42')) {
251
+ _context3.next = 2;
252
+ break;
253
+ }
254
+ return _context3.abrupt("return", false);
255
+ case 2:
256
+ _context3.next = 4;
257
+ return this.compileTemplate(template_id, data);
258
+ case 4:
259
+ _yield$this$compileTe2 = _context3.sent;
260
+ subject = _yield$this$compileTe2.subject;
261
+ html = _yield$this$compileTe2.html;
262
+ text = _yield$this$compileTe2.text;
263
+ if (!(!subject || !html && !text)) {
264
+ _context3.next = 10;
265
+ break;
266
+ }
267
+ return _context3.abrupt("return", false);
268
+ case 10:
269
+ _context3.prev = 10;
270
+ return _context3.abrupt("return", this.transporter_.sendMail({
271
+ from: from,
272
+ to: to,
273
+ subject: subject,
274
+ html: html,
275
+ text: text
276
+ }));
277
+ case 14:
278
+ _context3.prev = 14;
279
+ _context3.t0 = _context3["catch"](10);
280
+ throw _context3.t0;
281
+ case 17:
282
+ case "end":
283
+ return _context3.stop();
284
+ }
285
+ }, _callee3, this, [[10, 14]]);
286
+ }));
287
+ function sendEmail(_x7, _x8, _x9, _x10) {
288
+ return _sendEmail.apply(this, arguments);
289
+ }
290
+ return sendEmail;
291
+ }()
292
+ }, {
293
+ key: "compileTemplate",
294
+ value: function () {
295
+ var _compileTemplate = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(templateId, data) {
296
+ var base, subjectTemplate, htmlTemplate, textTemplate;
297
+ return _regeneratorRuntime().wrap(function _callee4$(_context4) {
298
+ while (1) switch (_context4.prev = _context4.next) {
299
+ case 0:
300
+ base = this.options_.template_path.startsWith('/') ? _path["default"].resolve(this.options_.template_path, templateId) :
301
+ // The path given in options is absolute
302
+ _path["default"].join(__dirname, '../../..', this.options_.template_path, templateId); // The path given in options is relative
303
+ subjectTemplate = _fs["default"].existsSync(_path["default"].join(base, 'subject.hbs')) ? _handlebars["default"].compile(_fs["default"].readFileSync(_path["default"].join(base, 'subject.hbs'), "utf8")) : null;
304
+ htmlTemplate = _fs["default"].existsSync(_path["default"].join(base, 'html.hbs')) ? _handlebars["default"].compile(_fs["default"].readFileSync(_path["default"].join(base, 'html.hbs'), "utf8")) : null;
305
+ textTemplate = _fs["default"].existsSync(_path["default"].join(base, 'text.hbs')) ? _handlebars["default"].compile(_fs["default"].readFileSync(_path["default"].join(base, 'text.hbs'), "utf8")) : null;
306
+ return _context4.abrupt("return", {
307
+ subject: subjectTemplate ? subjectTemplate(data) : null,
308
+ html: htmlTemplate ? htmlTemplate(data) : null,
309
+ text: textTemplate ? textTemplate(data) : null
310
+ });
311
+ case 5:
312
+ case "end":
313
+ return _context4.stop();
314
+ }
315
+ }, _callee4, this);
316
+ }));
317
+ function compileTemplate(_x11, _x12) {
318
+ return _compileTemplate.apply(this, arguments);
319
+ }
320
+ return compileTemplate;
209
321
  }()
210
322
  }, {
211
323
  key: "getLocalizedTemplateId",
@@ -288,230 +400,119 @@ var SESService = /*#__PURE__*/function (_NotificationService) {
288
400
  }
289
401
  }
290
402
  }, {
291
- key: "compileTemplate",
292
- value: function () {
293
- var _compileTemplate = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(templateId, data) {
294
- var base, subjectTemplate, htmlTemplate, textTemplate;
295
- return _regeneratorRuntime().wrap(function _callee3$(_context3) {
296
- while (1) switch (_context3.prev = _context3.next) {
297
- case 0:
298
- //const base = path.resolve(__dirname, '../../../', this.options_.template_path, templateId)
299
- base = _path["default"].resolve(this.options_.template_path, templateId);
300
- subjectTemplate = _handlebars["default"].compile(_fs["default"].readFileSync(_path["default"].join(base, 'subject.hbs'), "utf8"));
301
- htmlTemplate = _handlebars["default"].compile(_fs["default"].readFileSync(_path["default"].join(base, 'html.hbs'), "utf8"));
302
- textTemplate = _handlebars["default"].compile(_fs["default"].readFileSync(_path["default"].join(base, 'text.hbs'), "utf8"));
303
- return _context3.abrupt("return", {
304
- subject: subjectTemplate(data),
305
- html: htmlTemplate(data),
306
- text: textTemplate(data)
307
- });
308
- case 5:
309
- case "end":
310
- return _context3.stop();
311
- }
312
- }, _callee3, this);
313
- }));
314
- function compileTemplate(_x7, _x8) {
315
- return _compileTemplate.apply(this, arguments);
316
- }
317
- return compileTemplate;
318
- }()
319
- }, {
320
- key: "sendNotification",
403
+ key: "fetchAttachments",
321
404
  value: function () {
322
- var _sendNotification = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(event, eventData, attachmentGenerator) {
323
- var templateId, data, _yield$this$compileTe, subject, html, text, sendOptions, attachments, status;
324
- return _regeneratorRuntime().wrap(function _callee4$(_context4) {
325
- while (1) switch (_context4.prev = _context4.next) {
405
+ var _fetchAttachments = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee5(event, data, attachmentGenerator) {
406
+ var attachments, _data$return_request, shipping_method, shipping_data, provider, lbl, base64;
407
+ return _regeneratorRuntime().wrap(function _callee5$(_context5) {
408
+ while (1) switch (_context5.prev = _context5.next) {
326
409
  case 0:
327
- templateId = this.getTemplateId(event);
328
- if (templateId) {
329
- _context4.next = 3;
330
- break;
331
- }
332
- return _context4.abrupt("return", false);
410
+ _context5.t0 = event;
411
+ _context5.next = _context5.t0 === "swap.created" ? 3 : _context5.t0 === "order.return_requested" ? 3 : 17;
412
+ break;
333
413
  case 3:
334
- _context4.next = 5;
335
- return this.fetchData(event, eventData, attachmentGenerator);
336
- case 5:
337
- data = _context4.sent;
338
- if (data) {
339
- _context4.next = 8;
414
+ attachments = [];
415
+ _data$return_request = data.return_request, shipping_method = _data$return_request.shipping_method, shipping_data = _data$return_request.shipping_data;
416
+ if (!shipping_method) {
417
+ _context5.next = 11;
340
418
  break;
341
419
  }
342
- return _context4.abrupt("return", false);
343
- case 8:
344
- if (data.locale) {
345
- templateId = this.getLocalizedTemplateId(event, data.locale) || templateId;
346
- }
347
- _context4.next = 11;
348
- return this.compileTemplate(templateId, data);
420
+ provider = shipping_method.shipping_option.provider_id;
421
+ _context5.next = 9;
422
+ return this.fulfillmentProviderService_.retrieveDocuments(provider, shipping_data, "label");
423
+ case 9:
424
+ lbl = _context5.sent;
425
+ attachments = attachments.concat(lbl.map(function (d) {
426
+ return {
427
+ name: "return-label",
428
+ base64: d.base_64,
429
+ type: d.type
430
+ };
431
+ }));
349
432
  case 11:
350
- _yield$this$compileTe = _context4.sent;
351
- subject = _yield$this$compileTe.subject;
352
- html = _yield$this$compileTe.html;
353
- text = _yield$this$compileTe.text;
354
- if (!(!subject || !html && !text)) {
355
- _context4.next = 17;
433
+ if (!(attachmentGenerator && attachmentGenerator.createReturnInvoice)) {
434
+ _context5.next = 16;
356
435
  break;
357
436
  }
358
- return _context4.abrupt("return", false);
359
- case 17:
360
- sendOptions = {
361
- from: this.options_.from,
362
- to: data.email,
363
- subject: subject,
364
- html: html,
365
- text: text
366
- };
367
- _context4.next = 20;
368
- return this.fetchAttachments(event, data, attachmentGenerator);
369
- case 20:
370
- attachments = _context4.sent;
371
- if (attachments !== null && attachments !== void 0 && attachments.length) {
372
- sendOptions.attachments = attachments.map(function (a) {
373
- return {
374
- content: a.base64,
375
- filename: a.name,
376
- encoding: 'base64',
377
- contentType: a.type
378
- };
379
- });
380
- }
381
-
382
- //const status = await this.transporter_.sendMail(sendOptions).then(() => "sent").catch(() => "failed")
383
- _context4.next = 24;
384
- return this.transporter_.sendMail(sendOptions).then(function () {
385
- status = "sent";
386
- })["catch"](function (error) {
387
- status = "failed";
388
- console.log(error);
389
- });
390
- case 24:
391
- // We don't want heavy docs stored in DB
392
- delete sendOptions.attachments;
393
- return _context4.abrupt("return", {
394
- to: data.email,
395
- status: status,
396
- data: sendOptions
397
- });
398
- case 26:
399
- case "end":
400
- return _context4.stop();
401
- }
402
- }, _callee4, this);
403
- }));
404
- function sendNotification(_x9, _x10, _x11) {
405
- return _sendNotification.apply(this, arguments);
406
- }
407
- return sendNotification;
408
- }()
409
- }, {
410
- key: "resendNotification",
411
- value: function () {
412
- var _resendNotification = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee5(notification, config, attachmentGenerator) {
413
- var sendOptions, attachs, status;
414
- return _regeneratorRuntime().wrap(function _callee5$(_context5) {
415
- while (1) switch (_context5.prev = _context5.next) {
416
- case 0:
417
- sendOptions = _objectSpread(_objectSpread({}, notification.data), {}, {
418
- to: config.to || notification.to
419
- });
420
- _context5.next = 3;
421
- return this.fetchAttachments(notification.event_name, notification.data.dynamic_template_data, attachmentGenerator);
422
- case 3:
423
- attachs = _context5.sent;
424
- sendOptions.attachments = attachs.map(function (a) {
425
- return {
426
- content: a.base64,
427
- filename: a.name,
428
- encoding: 'base64',
429
- contentType: a.type
430
- };
431
- });
432
-
433
- //const status = await this.transporter_.sendMail(sendOptions).then(() => "sent").catch(() => "failed")
434
- _context5.next = 7;
435
- return this.transporter_.sendMail(sendOptions).then(function () {
436
- status = "sent";
437
- })["catch"](function (error) {
438
- status = "failed";
439
- console.log(error);
440
- });
441
- case 7:
442
- return _context5.abrupt("return", {
443
- to: sendOptions.to,
444
- status: status,
445
- data: sendOptions
437
+ _context5.next = 14;
438
+ return attachmentGenerator.createReturnInvoice(data.order, data.return_request.items);
439
+ case 14:
440
+ base64 = _context5.sent;
441
+ attachments.push({
442
+ name: "invoice",
443
+ base64: base64,
444
+ type: "application/pdf"
446
445
  });
447
- case 8:
446
+ case 16:
447
+ return _context5.abrupt("return", attachments);
448
+ case 17:
449
+ return _context5.abrupt("return", []);
450
+ case 18:
448
451
  case "end":
449
452
  return _context5.stop();
450
453
  }
451
454
  }, _callee5, this);
452
455
  }));
453
- function resendNotification(_x12, _x13, _x14) {
454
- return _resendNotification.apply(this, arguments);
456
+ function fetchAttachments(_x13, _x14, _x15) {
457
+ return _fetchAttachments.apply(this, arguments);
455
458
  }
456
- return resendNotification;
459
+ return fetchAttachments;
457
460
  }()
458
- /**
459
- * Sends an email using SES.
460
- * @param {string} template_id - id of template to use
461
- * @param {string} from - sender of email
462
- * @param {string} to - receiver of email
463
- * @param {Object} data - data to send in mail (match with template)
464
- * @return {Promise} result of the send operation
465
- */
466
461
  }, {
467
- key: "sendEmail",
462
+ key: "fetchData",
468
463
  value: function () {
469
- var _sendEmail = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee6(template_id, from, to, data) {
470
- var _yield$this$compileTe2, subject, html, text;
464
+ var _fetchData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee6(event, eventData, attachmentGenerator) {
471
465
  return _regeneratorRuntime().wrap(function _callee6$(_context6) {
472
466
  while (1) switch (_context6.prev = _context6.next) {
473
467
  case 0:
474
- if (!(this.options_.enable_endpoint !== '42')) {
475
- _context6.next = 2;
476
- break;
477
- }
478
- return _context6.abrupt("return", false);
479
- case 2:
480
- _context6.next = 4;
481
- return this.compileTemplate(template_id, data);
468
+ _context6.t0 = event;
469
+ _context6.next = _context6.t0 === "order.return_requested" ? 3 : _context6.t0 === "swap.shipment_created" ? 4 : _context6.t0 === "claim.shipment_created" ? 5 : _context6.t0 === "order.items_returned" ? 6 : _context6.t0 === "swap.received" ? 7 : _context6.t0 === "swap.created" ? 8 : _context6.t0 === "gift_card.created" ? 9 : _context6.t0 === "order.gift_card_created" ? 10 : _context6.t0 === "order.placed" ? 11 : _context6.t0 === "order.shipment_created" ? 12 : _context6.t0 === "order.canceled" ? 13 : _context6.t0 === "user.password_reset" ? 14 : _context6.t0 === "customer.password_reset" ? 15 : _context6.t0 === "restock-notification.restocked" ? 16 : _context6.t0 === "order.refund_created" ? 19 : 20;
470
+ break;
471
+ case 3:
472
+ return _context6.abrupt("return", this.returnRequestedData(eventData, attachmentGenerator));
482
473
  case 4:
483
- _yield$this$compileTe2 = _context6.sent;
484
- subject = _yield$this$compileTe2.subject;
485
- html = _yield$this$compileTe2.html;
486
- text = _yield$this$compileTe2.text;
487
- if (!(!subject || !html && !text)) {
488
- _context6.next = 10;
489
- break;
490
- }
491
- return _context6.abrupt("return", false);
474
+ return _context6.abrupt("return", this.swapShipmentCreatedData(eventData, attachmentGenerator));
475
+ case 5:
476
+ return _context6.abrupt("return", this.claimShipmentCreatedData(eventData, attachmentGenerator));
477
+ case 6:
478
+ return _context6.abrupt("return", this.itemsReturnedData(eventData, attachmentGenerator));
479
+ case 7:
480
+ return _context6.abrupt("return", this.swapReceivedData(eventData, attachmentGenerator));
481
+ case 8:
482
+ return _context6.abrupt("return", this.swapCreatedData(eventData, attachmentGenerator));
483
+ case 9:
484
+ return _context6.abrupt("return", this.gcCreatedData(eventData, attachmentGenerator));
492
485
  case 10:
493
- _context6.prev = 10;
494
- return _context6.abrupt("return", this.transporter_.sendMail({
495
- from: from,
496
- to: to,
497
- subject: subject,
498
- html: html,
499
- text: text
500
- }));
486
+ return _context6.abrupt("return", this.gcCreatedData(eventData, attachmentGenerator));
487
+ case 11:
488
+ return _context6.abrupt("return", this.orderPlacedData(eventData, attachmentGenerator));
489
+ case 12:
490
+ return _context6.abrupt("return", this.orderShipmentCreatedData(eventData, attachmentGenerator));
491
+ case 13:
492
+ return _context6.abrupt("return", this.orderCanceledData(eventData, attachmentGenerator));
501
493
  case 14:
502
- _context6.prev = 14;
503
- _context6.t0 = _context6["catch"](10);
504
- throw _context6.t0;
505
- case 17:
494
+ return _context6.abrupt("return", this.userPasswordResetData(eventData, attachmentGenerator));
495
+ case 15:
496
+ return _context6.abrupt("return", this.customerPasswordResetData(eventData, attachmentGenerator));
497
+ case 16:
498
+ _context6.next = 18;
499
+ return this.restockNotificationData(eventData, attachmentGenerator);
500
+ case 18:
501
+ return _context6.abrupt("return", _context6.sent);
502
+ case 19:
503
+ return _context6.abrupt("return", this.orderRefundCreatedData(eventData, attachmentGenerator));
504
+ case 20:
505
+ return _context6.abrupt("return", {});
506
+ case 21:
506
507
  case "end":
507
508
  return _context6.stop();
508
509
  }
509
- }, _callee6, this, [[10, 14]]);
510
+ }, _callee6, this);
510
511
  }));
511
- function sendEmail(_x15, _x16, _x17, _x18) {
512
- return _sendEmail.apply(this, arguments);
512
+ function fetchData(_x16, _x17, _x18) {
513
+ return _fetchData.apply(this, arguments);
513
514
  }
514
- return sendEmail;
515
+ return fetchData;
515
516
  }()
516
517
  }, {
517
518
  key: "orderShipmentCreatedData",