@creator.co/wapi 1.0.13 → 1.1.0

package/dist/index.d.ts

@@ -3,5 +3,6 @@ import Utils from "./src/API/Utils";
 import EventProcessor from "./src/BaseEvent/EventProcessor";
 import Process from "./src/BaseEvent/Process";
 import Transaction from "./src/BaseEvent/Transaction";
+import Mailer from "./src/Mailer/Mailer";
 import Publisher from "./src/Publisher/Publisher";
-export { Transaction, Process, EventProcessor, Publisher, Response, Utils, };
+export { Transaction, Process, EventProcessor, Publisher, Mailer, Response, Utils, };

package/dist/index.js

@@ -1,11 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Utils = exports.Response = exports.Publisher = exports.EventProcessor = exports.Process = exports.Transaction = void 0;
-// Base Events
-//
+exports.Utils = exports.Response = exports.Mailer = exports.Publisher = exports.EventProcessor = exports.Process = exports.Transaction = void 0;
 var Response_1 = require("./src/API/Response");
 exports.Response = Response_1.default;
-//Helpers
 var Utils_1 = require("./src/API/Utils");
 exports.Utils = Utils_1.default;
 var EventProcessor_1 = require("./src/BaseEvent/EventProcessor");
@@ -14,7 +11,8 @@ var Process_1 = require("./src/BaseEvent/Process");
 exports.Process = Process_1.default;
 var Transaction_1 = require("./src/BaseEvent/Transaction");
 exports.Transaction = Transaction_1.default;
-//
+var Mailer_1 = require("./src/Mailer/Mailer");
+exports.Mailer = Mailer_1.default;
 var Publisher_1 = require("./src/Publisher/Publisher");
 exports.Publisher = Publisher_1.default;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,cAAc;AACd,EAAE;AACF,+CAAyC;AAiBvC,mBAjBK,kBAAQ,CAiBL;AAhBV,SAAS;AACT,yCAAmC;AAiBjC,gBAjBK,eAAK,CAiBL;AAhBP,iEAA2D;AAUzD,yBAVK,wBAAc,CAUL;AAThB,mDAA6C;AAQ3C,kBARK,iBAAO,CAQL;AAPT,2DAAqD;AAMnD,sBANK,qBAAW,CAML;AALb,EAAE;AACF,uDAAiD;AAQ/C,oBARK,mBAAS,CAQL"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,+CAAyC;AAiBvC,mBAjBK,kBAAQ,CAiBL;AAhBV,yCAAmC;AAkBjC,gBAlBK,eAAK,CAkBL;AAjBP,iEAA2D;AAUzD,yBAVK,wBAAc,CAUL;AAThB,mDAA6C;AAQ3C,kBARK,iBAAO,CAQL;AAPT,2DAAqD;AAMnD,sBANK,qBAAW,CAML;AALb,8CAAwC;AAUtC,iBAVK,gBAAM,CAUL;AATR,uDAAiD;AAQ/C,oBARK,mBAAS,CAQL"}

package/dist/src/Mailer/Mailer.d.ts

@@ -0,0 +1,9 @@
+export default class Mailer {
+    private readonly from;
+    private readonly templateDefaultFile;
+    private readonly transporter;
+    constructor(defaultFrom: string, region: string);
+    sendTemplatedEmail(to: string | Array<string>, templates: string | Array<string>, data: object, optionalCC?: string | Array<string>, optionalAttachments?: any[]): Promise<any>;
+    private chooseTemplate;
+    private canRenderTemplate;
+}

package/dist/src/Mailer/Mailer.js

@@ -0,0 +1,166 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var SES = require("@aws-sdk/client-ses");
+var credential_provider_node_1 = require("@aws-sdk/credential-provider-node");
+var Email = require("email-templates");
+var nodemailer = require("nodemailer");
+var Mailer = /** @class */ (function () {
+    function Mailer(defaultFrom, region) {
+        this.templateDefaultFile = "html";
+        this.from = defaultFrom;
+        this.transporter = nodemailer.createTransport({
+            SES: {
+                ses: new SES.SESClient({
+                    credentials: (0, credential_provider_node_1.defaultProvider)(),
+                    apiVersion: "2010-12-01",
+                    region: region,
+                }),
+                aws: SES,
+            },
+        });
+    }
+    //to can be an array or just one address
+    Mailer.prototype.sendTemplatedEmail = function (to, templates, data, optionalCC, 
+    // TODO: improve attachment type -> Attachment
+    optionalAttachments) {
+        return __awaiter(this, void 0, void 0, function () {
+            var email, resp, chosenTemplate, e_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        email = new Email({
+                            message: __assign(__assign({ from: this.from, to: to }, (optionalAttachments ? { attachments: optionalAttachments } : {})), (optionalCC ? { cc: optionalCC } : {})),
+                            transport: this.transporter,
+                            send: true,
+                        });
+                        resp = null;
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 4, , 5]);
+                        return [4 /*yield*/, this.chooseTemplate(templates, data)];
+                    case 2:
+                        chosenTemplate = _a.sent();
+                        return [4 /*yield*/, email.send({ template: chosenTemplate, locals: data })];
+                    case 3:
+                        resp = _a.sent();
+                        console.debug("Mailer resp:", resp);
+                        return [3 /*break*/, 5];
+                    case 4:
+                        e_1 = _a.sent();
+                        console.error("Mailer error:", e_1);
+                        return [3 /*break*/, 5];
+                    case 5: return [2 /*return*/, resp];
+                }
+            });
+        });
+    };
+    /* private */
+    Mailer.prototype.chooseTemplate = function (templates, data) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _i, templates_1, template;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!Array.isArray(templates)) return [3 /*break*/, 5];
+                        _i = 0, templates_1 = templates;
+                        _a.label = 1;
+                    case 1:
+                        if (!(_i < templates_1.length)) return [3 /*break*/, 4];
+                        template = templates_1[_i];
+                        return [4 /*yield*/, this.canRenderTemplate(template, data)];
+                    case 2:
+                        if (_a.sent())
+                            return [2 /*return*/, template];
+                        _a.label = 3;
+                    case 3:
+                        _i++;
+                        return [3 /*break*/, 1];
+                    case 4: return [3 /*break*/, 7];
+                    case 5:
+                        if (!templates) return [3 /*break*/, 7];
+                        return [4 /*yield*/, this.canRenderTemplate(templates, data)];
+                    case 6:
+                        if (_a.sent())
+                            return [2 /*return*/, templates];
+                        _a.label = 7;
+                    case 7: throw new Error("Could not render email with template ".concat(templates, " and following data. Please, check logs above! ") +
+                        JSON.stringify(data, null, 2));
+                }
+            });
+        });
+    };
+    Mailer.prototype.canRenderTemplate = function (template, data) {
+        return __awaiter(this, void 0, void 0, function () {
+            var validRenderResp, email, e_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        validRenderResp = null;
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        email = new Email();
+                        return [4 /*yield*/, email.render("".concat(template, "/").concat(this.templateDefaultFile), data)];
+                    case 2:
+                        validRenderResp = _a.sent();
+                        return [3 /*break*/, 4];
+                    case 3:
+                        e_2 = _a.sent();
+                        console.log("Error while checking renderability of email template ".concat(template), e_2);
+                        return [3 /*break*/, 4];
+                    case 4: return [2 /*return*/, validRenderResp != null];
+                }
+            });
+        });
+    };
+    return Mailer;
+}());
+exports.default = Mailer;
+//# sourceMappingURL=Mailer.js.map

package/dist/src/Mailer/Mailer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Mailer.js","sourceRoot":"","sources":["../../../src/Mailer/Mailer.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA0C;AAC1C,8EAAmE;AACnE,uCAAwC;AACxC,uCAAwC;AAGxC;IAME,gBAAY,WAAmB,EAAE,MAAc;QAJ9B,wBAAmB,GAAW,MAAM,CAAA;QAKnD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAA;QACvB,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,eAAe,CAAC;YAC5C,GAAG,EAAE;gBACH,GAAG,EAAE,IAAI,GAAG,CAAC,SAAS,CAAC;oBACrB,WAAW,EAAE,IAAA,0CAAe,GAAE;oBAC9B,UAAU,EAAE,YAAY;oBACxB,MAAM,QAAA;iBACP,CAAC;gBACF,GAAG,EAAE,GAAG;aACT;SACF,CAAC,CAAA;IACJ,CAAC;IAED,wCAAwC;IAClC,mCAAkB,GAAxB,UACE,EAA0B,EAC1B,SAAiC,EACjC,IAAY,EACZ,UAAmC;IACnC,8CAA8C;IAC9C,mBAA2B;;;;;;wBAGrB,KAAK,GAAG,IAAI,KAAK,CAAC;4BACtB,OAAO,sBACL,IAAI,EAAE,IAAI,CAAC,IAAI,EACf,EAAE,EAAE,EAAE,IACH,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GACjE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAC1C;4BACD,SAAS,EAAE,IAAI,CAAC,WAAW;4BAC3B,IAAI,EAAE,IAAI;yBACX,CAAC,CAAA;wBAEE,IAAI,GAAG,IAAI,CAAA;;;;wBAEU,qBAAM,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,IAAI,CAAC,EAAA;;wBAA3D,cAAc,GAAG,SAA0C;wBAC1D,qBAAM,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAA;;wBAAnE,IAAI,GAAG,SAA4D,CAAA;wBACnE,OAAO,CAAC,KAAK,CAAC,cAAc,EAAE,IAAI,CAAC,CAAA;;;;wBAEnC,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,GAAC,CAAC,CAAA;;4BAEnC,sBAAO,IAAI,EAAA;;;;KACZ;IAED,aAAa;IACC,+BAAc,GAA5B,UACE,SAAiC,EACjC,IAAY;;;;;;6BAER,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAxB,wBAAwB;8BAEM,EAAT,uBAAS;;;6BAAT,CAAA,uBAAS,CAAA;wBAArB,QAAQ;wBACb,qBAAM,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAA;;wBAAhD,IAAI,SAA4C;4BAAE,sBAAO,QAAQ,EAAA;;;wBAD5C,IAAS,CAAA;;;;6BAGvB,SAAS,EAAT,wBAAS;wBACd,qBAAM,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,IAAI,CAAC,EAAA;;wBAAjD,IAAI,SAA6C;4BAAE,sBAAO,SAAS,EAAA;;4BAErE,MAAM,IAAI,KAAK,CACb,+CAAwC,SAAS,oDAAiD;wBAChG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAChC,CAAA;;;;KACF;IACa,kCAAiB,GAA/B,UACE,QAAgB,EAChB,IAAY;;;;;;wBAER,eAAe,GAAG,IAAI,CAAA;;;;wBAElB,KAAK,GAAG,IAAI,KAAK,EAAE,CAAA;wBACP,qBAAM,KAAK,CAAC,MAAM,CAClC,UAAG,QAAQ,cAAI,IAAI,CAAC,mBAAmB,CAAE,EACzC,IAAI,CACL,EAAA;;wBAHD,eAAe,GAAG,SAGjB,CAAA;;;;wBAED,OAAO,CAAC,GAAG,CACT,+DAAwD,QAAQ,CAAE,EAClE,GAAC,CACF,CAAA;;4BAEH,sBAAO,eAAe,IAAI,IAAI,EAAA;;;;KAC/B;IACH,aAAC;AAAD,CAAC,AAzFD,IAyFC"}

package/index.ts

@@ -1,14 +1,11 @@
-// Base Events
-//
 import Response from "./src/API/Response"
-//Helpers
 import Utils from "./src/API/Utils"
 import EventProcessor from "./src/BaseEvent/EventProcessor"
 import Process from "./src/BaseEvent/Process"
 import Transaction from "./src/BaseEvent/Transaction"
-//
+import Mailer from "./src/Mailer/Mailer"
 import Publisher from "./src/Publisher/Publisher"
-//
+
 export {
   //Base Events
   Transaction,
@@ -16,6 +13,7 @@ export {
   EventProcessor,
   //Client
   Publisher,
+  Mailer,
   //Responses
   Response,
   //Helpers

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@creator.co/wapi",
-  "version": "1.0.13",
+  "version": "1.1.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -14,19 +14,24 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "@aws-sdk/client-ses": "^3.414.0",
     "@aws-sdk/client-sns": "^3.398.0",
+    "@aws-sdk/credential-provider-node": "^3.414.0",
+    "@types/email-templates": "^10.0.1",
+    "@types/nodemailer": "^6.4.10",
     "abind": "^1.0.5",
+    "email-templates": "^11.1.1",
     "json-stringify-safe": "^5.0.1",
     "sha1": "^1.1.1",
     "stack-trace": "0.0.10"
   },
   "devDependencies": {
     "@types/aws-lambda": "^8.10.119",
-    "eslint-config-prettier": "^9.0.0",
     "@types/node": "^20.5.7",
     "@typescript-eslint/eslint-plugin": "^6.5.0",
     "@typescript-eslint/parser": "^6.5.0",
     "eslint": "^8.48.0",
+    "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-prettier": "^5.0.0",
     "prettier": "^3.0.3"

package/src/Mailer/Mailer.ts

@@ -0,0 +1,96 @@
+import * as SES from "@aws-sdk/client-ses"
+import { defaultProvider } from "@aws-sdk/credential-provider-node"
+import * as Email from "email-templates"
+import * as nodemailer from "nodemailer"
+import SESTransport = require("nodemailer/lib/ses-transport")
+
+export default class Mailer {
+  private readonly from: string
+  private readonly templateDefaultFile: string = "html"
+  private readonly transporter: ReturnType<
+    typeof nodemailer.createTransport<SESTransport.SentMessageInfo>
+  >
+  constructor(defaultFrom: string, region: string) {
+    this.from = defaultFrom
+    this.transporter = nodemailer.createTransport({
+      SES: {
+        ses: new SES.SESClient({
+          credentials: defaultProvider(),
+          apiVersion: "2010-12-01",
+          region,
+        }),
+        aws: SES,
+      },
+    })
+  }
+
+  //to can be an array or just one address
+  async sendTemplatedEmail(
+    to: string | Array<string>,
+    templates: string | Array<string>,
+    data: object,
+    optionalCC?: string | Array<string>,
+    // TODO: improve attachment type -> Attachment
+    optionalAttachments?: any[],
+  ) {
+    //Generate emails
+    const email = new Email({
+      message: {
+        from: this.from,
+        to: to,
+        ...(optionalAttachments ? { attachments: optionalAttachments } : {}),
+        ...(optionalCC ? { cc: optionalCC } : {}),
+      },
+      transport: this.transporter,
+      send: true,
+    })
+    //
+    let resp = null
+    try {
+      const chosenTemplate = await this.chooseTemplate(templates, data)
+      resp = await email.send({ template: chosenTemplate, locals: data })
+      console.debug("Mailer resp:", resp)
+    } catch (e) {
+      console.error("Mailer error:", e)
+    }
+    return resp
+  }
+
+  /* private */
+  private async chooseTemplate(
+    templates: string | Array<string>,
+    data: object,
+  ): Promise<string> {
+    if (Array.isArray(templates)) {
+      //For each template check if can render it
+      for (const template of templates) {
+        if (await this.canRenderTemplate(template, data)) return template
+      }
+    } else if (templates) {
+      if (await this.canRenderTemplate(templates, data)) return templates
+    }
+    throw new Error(
+      `Could not render email with template ${templates} and following data. Please, check logs above! ` +
+        JSON.stringify(data, null, 2),
+    )
+  }
+  private async canRenderTemplate(
+    template: string,
+    data: object,
+  ): Promise<boolean> {
+    let validRenderResp = null
+    try {
+      const email = new Email()
+      validRenderResp = await email.render(
+        `${template}/${this.templateDefaultFile}`,
+        data,
+      )
+    } catch (e) {
+      console.log(
+        `Error while checking renderability of email template ${template}`,
+        e,
+      )
+    }
+    return validRenderResp != null
+  }
+}