@webiny/api-mailer 5.30.0-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,14 @@
+# @webiny/api-mailer
+[![](https://img.shields.io/npm/dw/@webiny/api-mailer.svg)](https://www.npmjs.com/package/@webiny/api-mailer) 
+[![](https://img.shields.io/npm/v/@webiny/api-mailer.svg)](https://www.npmjs.com/package/@webiny/api-mailer)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+
+  
+## Install
+```
+yarn add @webiny/api-mailer
+```
+
+## Documentation
+[Webiny Documentation > Overview > Features > Mailer](https://www.webiny.com/docs/overview/features/mailer)

package/context.d.ts

@@ -0,0 +1,3 @@
+import { ContextPlugin } from "@webiny/handler";
+import { MailerConfig, MailerContext } from "./types";
+export declare const createMailerContext: (config?: MailerConfig) => ContextPlugin<MailerContext>;

package/context.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createMailerContext = void 0;
+
+var _handler = require("@webiny/handler");
+
+var _mailer = require("./crud/mailer.crud");
+
+const createMailerContext = config => {
+  return new _handler.ContextPlugin(async context => {
+    context.mailer = (0, _mailer.createMailerCrud)(config);
+  });
+};
+
+exports.createMailerContext = createMailerContext;

package/context.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createMailerContext","config","ContextPlugin","context","mailer","createMailerCrud"],"sources":["context.ts"],"sourcesContent":["import { ContextPlugin } from \"@webiny/handler\";\nimport { MailerConfig, MailerContext } from \"./types\";\nimport { createMailerCrud } from \"~/crud/mailer.crud\";\n\nexport const createMailerContext = (config?: MailerConfig) => {\n    return new ContextPlugin<MailerContext>(async context => {\n        context.mailer = createMailerCrud(config);\n    });\n};\n"],"mappings":";;;;;;;AAAA;;AAEA;;AAEO,MAAMA,mBAAmB,GAAIC,MAAD,IAA2B;EAC1D,OAAO,IAAIC,sBAAJ,CAAiC,MAAMC,OAAN,IAAiB;IACrDA,OAAO,CAACC,MAAR,GAAiB,IAAAC,wBAAA,EAAiBJ,MAAjB,CAAjB;EACH,CAFM,CAAP;AAGH,CAJM"}

package/crud/mailer/onBeforeSend.d.ts

@@ -0,0 +1,7 @@
+import { Topic } from "@webiny/pubsub/types";
+import { OnBeforeMailerSendParams } from "../../types";
+interface AttachOnBeforeSendParams {
+    onBeforeSend: Topic<OnBeforeMailerSendParams>;
+}
+export declare const attachOnBeforeSend: (params: AttachOnBeforeSendParams) => void;
+export {};

package/crud/mailer/onBeforeSend.js

@@ -0,0 +1,69 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.attachOnBeforeSend = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _joi = _interopRequireDefault(require("joi"));
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+const requiredString = _joi.default.string().required();
+
+const requiredEmail = requiredString.email();
+
+const schema = _joi.default.object({
+  to: _joi.default.array().items(requiredEmail).required(),
+  from: requiredEmail,
+  subject: requiredString.max(1024),
+  cc: _joi.default.array().items(requiredEmail),
+  bcc: _joi.default.array().items(requiredEmail),
+  replyTo: _joi.default.string().email(),
+  text: requiredString.min(10),
+  html: _joi.default.string()
+});
+
+const attachOnBeforeSend = params => {
+  const {
+    onBeforeSend
+  } = params;
+  onBeforeSend.subscribe(async ({
+    data: input
+  }) => {
+    let result;
+
+    try {
+      result = await schema.validate(input);
+
+      if (!result.error) {
+        return;
+      }
+    } catch (ex) {
+      throw new _error.default({
+        message: "Error while validating e-mail params.",
+        code: "VALIDATION_ERROR",
+        data: {
+          input,
+          error: ex
+        }
+      });
+    }
+
+    throw new _error.default({
+      message: "Error while validating e-mail params.",
+      code: "VALIDATION_ERROR",
+      data: _objectSpread({}, result.error)
+    });
+  });
+};
+
+exports.attachOnBeforeSend = attachOnBeforeSend;

package/crud/mailer/onBeforeSend.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["requiredString","joi","string","required","requiredEmail","email","schema","object","to","array","items","from","subject","max","cc","bcc","replyTo","text","min","html","attachOnBeforeSend","params","onBeforeSend","subscribe","data","input","result","validate","error","ex","WebinyError","message","code"],"sources":["onBeforeSend.ts"],"sourcesContent":["import { Topic } from \"@webiny/pubsub/types\";\nimport { MailerSendData, OnBeforeMailerSendParams } from \"~/types\";\nimport joi from \"joi\";\nimport WebinyError from \"@webiny/error\";\n\nconst requiredString = joi.string().required();\nconst requiredEmail = requiredString.email();\n\nconst schema = joi.object<MailerSendData>({\n    to: joi.array().items(requiredEmail).required(),\n    from: requiredEmail,\n    subject: requiredString.max(1024),\n    cc: joi.array().items(requiredEmail),\n    bcc: joi.array().items(requiredEmail),\n    replyTo: joi.string().email(),\n    text: requiredString.min(10),\n    html: joi.string()\n});\n\ninterface AttachOnBeforeSendParams {\n    onBeforeSend: Topic<OnBeforeMailerSendParams>;\n}\nexport const attachOnBeforeSend = (params: AttachOnBeforeSendParams) => {\n    const { onBeforeSend } = params;\n\n    onBeforeSend.subscribe(async ({ data: input }) => {\n        let result: joi.ValidationResult<MailerSendData>;\n        try {\n            result = await schema.validate(input);\n\n            if (!result.error) {\n                return;\n            }\n        } catch (ex) {\n            throw new WebinyError({\n                message: \"Error while validating e-mail params.\",\n                code: \"VALIDATION_ERROR\",\n                data: {\n                    input,\n                    error: ex\n                }\n            });\n        }\n        throw new WebinyError({\n            message: \"Error while validating e-mail params.\",\n            code: \"VALIDATION_ERROR\",\n            data: {\n                ...result.error\n            }\n        });\n    });\n};\n"],"mappings":";;;;;;;;;;;AAEA;;AACA;;;;;;AAEA,MAAMA,cAAc,GAAGC,YAAA,CAAIC,MAAJ,GAAaC,QAAb,EAAvB;;AACA,MAAMC,aAAa,GAAGJ,cAAc,CAACK,KAAf,EAAtB;;AAEA,MAAMC,MAAM,GAAGL,YAAA,CAAIM,MAAJ,CAA2B;EACtCC,EAAE,EAAEP,YAAA,CAAIQ,KAAJ,GAAYC,KAAZ,CAAkBN,aAAlB,EAAiCD,QAAjC,EADkC;EAEtCQ,IAAI,EAAEP,aAFgC;EAGtCQ,OAAO,EAAEZ,cAAc,CAACa,GAAf,CAAmB,IAAnB,CAH6B;EAItCC,EAAE,EAAEb,YAAA,CAAIQ,KAAJ,GAAYC,KAAZ,CAAkBN,aAAlB,CAJkC;EAKtCW,GAAG,EAAEd,YAAA,CAAIQ,KAAJ,GAAYC,KAAZ,CAAkBN,aAAlB,CALiC;EAMtCY,OAAO,EAAEf,YAAA,CAAIC,MAAJ,GAAaG,KAAb,EAN6B;EAOtCY,IAAI,EAAEjB,cAAc,CAACkB,GAAf,CAAmB,EAAnB,CAPgC;EAQtCC,IAAI,EAAElB,YAAA,CAAIC,MAAJ;AARgC,CAA3B,CAAf;;AAcO,MAAMkB,kBAAkB,GAAIC,MAAD,IAAsC;EACpE,MAAM;IAAEC;EAAF,IAAmBD,MAAzB;EAEAC,YAAY,CAACC,SAAb,CAAuB,OAAO;IAAEC,IAAI,EAAEC;EAAR,CAAP,KAA2B;IAC9C,IAAIC,MAAJ;;IACA,IAAI;MACAA,MAAM,GAAG,MAAMpB,MAAM,CAACqB,QAAP,CAAgBF,KAAhB,CAAf;;MAEA,IAAI,CAACC,MAAM,CAACE,KAAZ,EAAmB;QACf;MACH;IACJ,CAND,CAME,OAAOC,EAAP,EAAW;MACT,MAAM,IAAIC,cAAJ,CAAgB;QAClBC,OAAO,EAAE,uCADS;QAElBC,IAAI,EAAE,kBAFY;QAGlBR,IAAI,EAAE;UACFC,KADE;UAEFG,KAAK,EAAEC;QAFL;MAHY,CAAhB,CAAN;IAQH;;IACD,MAAM,IAAIC,cAAJ,CAAgB;MAClBC,OAAO,EAAE,uCADS;MAElBC,IAAI,EAAE,kBAFY;MAGlBR,IAAI,oBACGE,MAAM,CAACE,KADV;IAHc,CAAhB,CAAN;EAOH,CAzBD;AA0BH,CA7BM"}

package/crud/mailer.crud.d.ts

@@ -0,0 +1,2 @@
+import { MailerConfig, MailerContextObject } from "../types";
+export declare const createMailerCrud: (config?: MailerConfig) => MailerContextObject;

package/crud/mailer.crud.js

@@ -0,0 +1,123 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createMailerCrud = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _pubsub = require("@webiny/pubsub");
+
+var _onBeforeSend = require("./mailer/onBeforeSend");
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+const createDefaultMailer = async () => {
+  return Promise.resolve().then(() => _interopRequireWildcard(require("../mailers/createSmtpMailer"))).then(module => {
+    return module.createSmtpMailer();
+  });
+};
+
+const createMailerCrud = config => {
+  let defaultMailer = (config === null || config === void 0 ? void 0 : config.mailer) || createDefaultMailer;
+  /**
+   * We define possible events to be hooked into.
+   */
+
+  const onBeforeSend = (0, _pubsub.createTopic)();
+  const onAfterSend = (0, _pubsub.createTopic)();
+  const onError = (0, _pubsub.createTopic)();
+  /**
+   * We attach our default ones.
+   */
+
+  (0, _onBeforeSend.attachOnBeforeSend)({
+    onBeforeSend
+  });
+  let initializedMailer;
+
+  const getMailer = async () => {
+    if (initializedMailer) {
+      return initializedMailer;
+    } else if (!defaultMailer) {
+      throw new _error.default({
+        message: "Mailer is not set.",
+        code: "MAILER_NOT_SET_ERROR"
+      });
+    } else if (typeof defaultMailer === "function") {
+      try {
+        initializedMailer = await defaultMailer();
+        return initializedMailer;
+      } catch (ex) {
+        throw new _error.default({
+          message: "Error while getting mailer.",
+          code: "MAILER_ERROR",
+          data: {
+            error: ex
+          }
+        });
+      }
+    }
+
+    initializedMailer = defaultMailer;
+    return initializedMailer;
+  };
+
+  return {
+    onBeforeSend,
+    onAfterSend,
+    onError,
+    getMailer,
+    setMailer: target => {
+      initializedMailer = undefined;
+      defaultMailer = target;
+    },
+    send: async ({
+      data
+    }) => {
+      const mailer = await getMailer();
+
+      try {
+        await onBeforeSend.publish({
+          data
+        });
+        const response = await mailer.send(data);
+        await onAfterSend.publish({
+          data
+        });
+        return {
+          result: response.result,
+          error: response.error
+        };
+      } catch (ex) {
+        await onError.publish({
+          error: ex,
+          data
+        });
+        return {
+          result: null,
+          error: {
+            message: ex.message,
+            code: ex.code,
+            data: _objectSpread({
+              data
+            }, ex.data)
+          }
+        };
+      }
+    }
+  };
+};
+
+exports.createMailerCrud = createMailerCrud;

package/crud/mailer.crud.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createDefaultMailer","then","module","createSmtpMailer","createMailerCrud","config","defaultMailer","mailer","onBeforeSend","createTopic","onAfterSend","onError","attachOnBeforeSend","initializedMailer","getMailer","WebinyError","message","code","ex","data","error","setMailer","target","undefined","send","publish","response","result"],"sources":["mailer.crud.ts"],"sourcesContent":["import {\n    MailerConfig,\n    MailerContextObject,\n    Mailer,\n    MailerSetterParams,\n    OnAfterMailerSendParams,\n    OnBeforeMailerSendParams,\n    OnErrorMailerParams\n} from \"~/types\";\nimport { createTopic } from \"@webiny/pubsub\";\nimport { attachOnBeforeSend } from \"~/crud/mailer/onBeforeSend\";\nimport WebinyError from \"@webiny/error\";\n\nconst createDefaultMailer = async () => {\n    return import(\"~/mailers/createSmtpMailer\").then(module => {\n        return module.createSmtpMailer();\n    });\n};\n\nexport const createMailerCrud = (config?: MailerConfig): MailerContextObject => {\n    let defaultMailer: MailerSetterParams | undefined = config?.mailer || createDefaultMailer;\n    /**\n     * We define possible events to be hooked into.\n     */\n    const onBeforeSend = createTopic<OnBeforeMailerSendParams>();\n    const onAfterSend = createTopic<OnAfterMailerSendParams>();\n    const onError = createTopic<OnErrorMailerParams>();\n    /**\n     * We attach our default ones.\n     */\n    attachOnBeforeSend({\n        onBeforeSend\n    });\n\n    let initializedMailer: Mailer | undefined;\n\n    const getMailer = async <T extends Mailer = Mailer>(): Promise<T> => {\n        if (initializedMailer) {\n            return initializedMailer as T;\n        } else if (!defaultMailer) {\n            throw new WebinyError({\n                message: \"Mailer is not set.\",\n                code: \"MAILER_NOT_SET_ERROR\"\n            });\n        } else if (typeof defaultMailer === \"function\") {\n            try {\n                initializedMailer = await defaultMailer();\n\n                return initializedMailer as T;\n            } catch (ex) {\n                throw new WebinyError({\n                    message: \"Error while getting mailer.\",\n                    code: \"MAILER_ERROR\",\n                    data: {\n                        error: ex\n                    }\n                });\n            }\n        }\n        initializedMailer = defaultMailer;\n        return initializedMailer as T;\n    };\n\n    return {\n        onBeforeSend,\n        onAfterSend,\n        onError,\n        getMailer,\n        setMailer: target => {\n            initializedMailer = undefined;\n            defaultMailer = target;\n        },\n        send: async ({ data }) => {\n            const mailer = await getMailer();\n            try {\n                await onBeforeSend.publish({\n                    data\n                });\n                const response = await mailer.send(data);\n                await onAfterSend.publish({\n                    data\n                });\n\n                return {\n                    result: response.result,\n                    error: response.error\n                };\n            } catch (ex) {\n                await onError.publish({\n                    error: ex,\n                    data\n                });\n                return {\n                    result: null,\n                    error: {\n                        message: ex.message,\n                        code: ex.code,\n                        data: {\n                            data,\n                            ...ex.data\n                        }\n                    }\n                };\n            }\n        }\n    };\n};\n"],"mappings":";;;;;;;;;;;AASA;;AACA;;AACA;;;;;;;;;;AAEA,MAAMA,mBAAmB,GAAG,YAAY;EACpC,OAAO,8FAAqCC,IAArC,CAA0CC,MAAM,IAAI;IACvD,OAAOA,MAAM,CAACC,gBAAP,EAAP;EACH,CAFM,CAAP;AAGH,CAJD;;AAMO,MAAMC,gBAAgB,GAAIC,MAAD,IAAgD;EAC5E,IAAIC,aAA6C,GAAG,CAAAD,MAAM,SAAN,IAAAA,MAAM,WAAN,YAAAA,MAAM,CAAEE,MAAR,KAAkBP,mBAAtE;EACA;AACJ;AACA;;EACI,MAAMQ,YAAY,GAAG,IAAAC,mBAAA,GAArB;EACA,MAAMC,WAAW,GAAG,IAAAD,mBAAA,GAApB;EACA,MAAME,OAAO,GAAG,IAAAF,mBAAA,GAAhB;EACA;AACJ;AACA;;EACI,IAAAG,gCAAA,EAAmB;IACfJ;EADe,CAAnB;EAIA,IAAIK,iBAAJ;;EAEA,MAAMC,SAAS,GAAG,YAAmD;IACjE,IAAID,iBAAJ,EAAuB;MACnB,OAAOA,iBAAP;IACH,CAFD,MAEO,IAAI,CAACP,aAAL,EAAoB;MACvB,MAAM,IAAIS,cAAJ,CAAgB;QAClBC,OAAO,EAAE,oBADS;QAElBC,IAAI,EAAE;MAFY,CAAhB,CAAN;IAIH,CALM,MAKA,IAAI,OAAOX,aAAP,KAAyB,UAA7B,EAAyC;MAC5C,IAAI;QACAO,iBAAiB,GAAG,MAAMP,aAAa,EAAvC;QAEA,OAAOO,iBAAP;MACH,CAJD,CAIE,OAAOK,EAAP,EAAW;QACT,MAAM,IAAIH,cAAJ,CAAgB;UAClBC,OAAO,EAAE,6BADS;UAElBC,IAAI,EAAE,cAFY;UAGlBE,IAAI,EAAE;YACFC,KAAK,EAAEF;UADL;QAHY,CAAhB,CAAN;MAOH;IACJ;;IACDL,iBAAiB,GAAGP,aAApB;IACA,OAAOO,iBAAP;EACH,CAzBD;;EA2BA,OAAO;IACHL,YADG;IAEHE,WAFG;IAGHC,OAHG;IAIHG,SAJG;IAKHO,SAAS,EAAEC,MAAM,IAAI;MACjBT,iBAAiB,GAAGU,SAApB;MACAjB,aAAa,GAAGgB,MAAhB;IACH,CARE;IASHE,IAAI,EAAE,OAAO;MAAEL;IAAF,CAAP,KAAoB;MACtB,MAAMZ,MAAM,GAAG,MAAMO,SAAS,EAA9B;;MACA,IAAI;QACA,MAAMN,YAAY,CAACiB,OAAb,CAAqB;UACvBN;QADuB,CAArB,CAAN;QAGA,MAAMO,QAAQ,GAAG,MAAMnB,MAAM,CAACiB,IAAP,CAAYL,IAAZ,CAAvB;QACA,MAAMT,WAAW,CAACe,OAAZ,CAAoB;UACtBN;QADsB,CAApB,CAAN;QAIA,OAAO;UACHQ,MAAM,EAAED,QAAQ,CAACC,MADd;UAEHP,KAAK,EAAEM,QAAQ,CAACN;QAFb,CAAP;MAIH,CAbD,CAaE,OAAOF,EAAP,EAAW;QACT,MAAMP,OAAO,CAACc,OAAR,CAAgB;UAClBL,KAAK,EAAEF,EADW;UAElBC;QAFkB,CAAhB,CAAN;QAIA,OAAO;UACHQ,MAAM,EAAE,IADL;UAEHP,KAAK,EAAE;YACHJ,OAAO,EAAEE,EAAE,CAACF,OADT;YAEHC,IAAI,EAAEC,EAAE,CAACD,IAFN;YAGHE,IAAI;cACAA;YADA,GAEGD,EAAE,CAACC,IAFN;UAHD;QAFJ,CAAP;MAWH;IACJ;EAzCE,CAAP;AA2CH,CAvFM"}

package/index.d.ts

@@ -0,0 +1,7 @@
+import { PluginCollection } from "@webiny/plugins/types";
+import { MailerConfig } from "./types";
+import { createDummyMailer, DummyMailer } from "./mailers/createDummyMailer";
+import { createSmtpMailer, SmtpMailerConfig, SmtpMailer } from "./mailers/createSmtpMailer";
+export { createDummyMailer, createSmtpMailer };
+export type { SmtpMailerConfig, SmtpMailer, DummyMailer };
+export declare const createMailer: (config?: MailerConfig) => PluginCollection;

package/index.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "createDummyMailer", {
+  enumerable: true,
+  get: function () {
+    return _createDummyMailer.createDummyMailer;
+  }
+});
+exports.createMailer = void 0;
+Object.defineProperty(exports, "createSmtpMailer", {
+  enumerable: true,
+  get: function () {
+    return _createSmtpMailer.createSmtpMailer;
+  }
+});
+
+var _context = require("./context");
+
+var _createDummyMailer = require("./mailers/createDummyMailer");
+
+var _createSmtpMailer = require("./mailers/createSmtpMailer");
+
+const createMailer = config => {
+  return [(0, _context.createMailerContext)(config)];
+};
+
+exports.createMailer = createMailer;

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createMailer","config","createMailerContext"],"sources":["index.ts"],"sourcesContent":["import { PluginCollection } from \"@webiny/plugins/types\";\nimport { createMailerContext } from \"~/context\";\nimport { MailerConfig } from \"~/types\";\nimport { createDummyMailer, DummyMailer } from \"~/mailers/createDummyMailer\";\nimport { createSmtpMailer, SmtpMailerConfig, SmtpMailer } from \"~/mailers/createSmtpMailer\";\n\nexport { createDummyMailer, createSmtpMailer };\nexport type { SmtpMailerConfig, SmtpMailer, DummyMailer };\n\nexport const createMailer = (config?: MailerConfig): PluginCollection => {\n    return [createMailerContext(config)];\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;AACA;;AAEA;;AACA;;AAKO,MAAMA,YAAY,GAAIC,MAAD,IAA6C;EACrE,OAAO,CAAC,IAAAC,4BAAA,EAAoBD,MAApB,CAAD,CAAP;AACH,CAFM"}

package/mailers/createDummyMailer.d.ts

@@ -0,0 +1,5 @@
+import { Mailer, MailerSendData } from "../types";
+export interface DummyMailer extends Mailer {
+    getAllSent: () => MailerSendData[];
+}
+export declare const createDummyMailer: () => DummyMailer;

package/mailers/createDummyMailer.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createDummyMailer = void 0;
+
+const createDummyMailer = () => {
+  const sent = [];
+  return {
+    send: async params => {
+      sent.push(params);
+      return {
+        result: true,
+        error: null
+      };
+    },
+    getAllSent: () => {
+      return sent;
+    }
+  };
+};
+
+exports.createDummyMailer = createDummyMailer;

package/mailers/createDummyMailer.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createDummyMailer","sent","send","params","push","result","error","getAllSent"],"sources":["createDummyMailer.ts"],"sourcesContent":["import { Mailer, MailerSendData } from \"~/types\";\n\nexport interface DummyMailer extends Mailer {\n    getAllSent: () => MailerSendData[];\n}\nexport const createDummyMailer = (): DummyMailer => {\n    const sent: MailerSendData[] = [];\n\n    return {\n        send: async params => {\n            sent.push(params);\n            return {\n                result: true,\n                error: null\n            };\n        },\n        getAllSent: () => {\n            return sent;\n        }\n    };\n};\n"],"mappings":";;;;;;;AAKO,MAAMA,iBAAiB,GAAG,MAAmB;EAChD,MAAMC,IAAsB,GAAG,EAA/B;EAEA,OAAO;IACHC,IAAI,EAAE,MAAMC,MAAN,IAAgB;MAClBF,IAAI,CAACG,IAAL,CAAUD,MAAV;MACA,OAAO;QACHE,MAAM,EAAE,IADL;QAEHC,KAAK,EAAE;MAFJ,CAAP;IAIH,CAPE;IAQHC,UAAU,EAAE,MAAM;MACd,OAAON,IAAP;IACH;EAVE,CAAP;AAYH,CAfM"}

package/mailers/createSmtpMailer.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Nodemailer docs
+ * https://nodemailer.com/about/
+ */
+import { Mailer } from "../types";
+import { Transporter } from "nodemailer";
+import SMTPTransport, { Options } from "nodemailer/lib/smtp-transport";
+import { DummyMailer } from "./createDummyMailer";
+export declare type SmtpMailerConfig = Options;
+export interface SmtpMailer extends Mailer {
+    transporter: Transporter<SMTPTransport.SentMessageInfo>;
+}
+export declare const createSmtpMailer: (config?: SmtpMailerConfig) => SmtpMailer | DummyMailer;

package/mailers/createSmtpMailer.js

@@ -0,0 +1,106 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createSmtpMailer = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _nodemailer = _interopRequireDefault(require("nodemailer"));
+
+var _createDummyMailer = require("./createDummyMailer");
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+const variables = {
+  host: process.env.WEBINY_MAILER_HOST,
+  user: process.env.WEBINY_MAILER_USER,
+  password: process.env.WEBINY_MAILER_PASSWORD
+};
+
+const createSmtpMailer = config => {
+  /**
+   * If we have environment variables, use those as config.
+   */
+  if (variables.host && variables.user && variables.password) {
+    if (config) {
+      throw new _error.default({
+        message: `Cannot use both config and environment variables to setup the nodemailer.`,
+        code: "SMTP_MAILER_INIT_ERROR"
+      });
+    }
+
+    config = {
+      host: variables.host,
+      auth: {
+        user: variables.user,
+        pass: variables.password
+      }
+    };
+  } else if (!config) {
+    console.log("There is no config or required environment variables defined. Using dummy mailer.");
+    return (0, _createDummyMailer.createDummyMailer)();
+  }
+
+  const transporter = _nodemailer.default.createTransport(_objectSpread({}, config));
+
+  return {
+    transporter,
+    send: async params => {
+      const {
+        replyTo,
+        text,
+        html,
+        to,
+        bcc,
+        cc,
+        from,
+        subject
+      } = params;
+
+      try {
+        const result = await transporter.sendMail({
+          replyTo,
+          bcc,
+          cc,
+          from,
+          text,
+          html,
+          to,
+          subject
+        });
+
+        if (result.messageId) {
+          return {
+            result: true,
+            error: null
+          };
+        }
+
+        throw new _error.default({
+          message: "nodemailer.sendMail does not have a messageId in the result. Something went wrong...",
+          code: "MAILER_ERROR",
+          data: _objectSpread({}, result)
+        });
+      } catch (ex) {
+        return {
+          result: null,
+          error: {
+            message: ex.message,
+            code: ex.code,
+            data: _objectSpread(_objectSpread({}, params), ex.data)
+          }
+        };
+      }
+    }
+  };
+};
+
+exports.createSmtpMailer = createSmtpMailer;

package/mailers/createSmtpMailer.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["variables","host","process","env","WEBINY_MAILER_HOST","user","WEBINY_MAILER_USER","password","WEBINY_MAILER_PASSWORD","createSmtpMailer","config","WebinyError","message","code","auth","pass","console","log","createDummyMailer","transporter","nodemailer","createTransport","send","params","replyTo","text","html","to","bcc","cc","from","subject","result","sendMail","messageId","error","data","ex"],"sources":["createSmtpMailer.ts"],"sourcesContent":["/**\n * Nodemailer docs\n * https://nodemailer.com/about/\n */\nimport { Mailer } from \"~/types\";\nimport WebinyError from \"@webiny/error\";\nimport nodemailer, { Transporter } from \"nodemailer\";\nimport SMTPTransport, { Options } from \"nodemailer/lib/smtp-transport\";\nimport { createDummyMailer, DummyMailer } from \"~/mailers/createDummyMailer\";\n\nexport type SmtpMailerConfig = Options;\n\nexport interface SmtpMailer extends Mailer {\n    transporter: Transporter<SMTPTransport.SentMessageInfo>;\n}\n\ninterface SmtpMailerEnvironmentVariables {\n    host?: string;\n    user?: string;\n    password?: string;\n}\nconst variables: SmtpMailerEnvironmentVariables = {\n    host: process.env.WEBINY_MAILER_HOST,\n    user: process.env.WEBINY_MAILER_USER,\n    password: process.env.WEBINY_MAILER_PASSWORD\n};\n\nexport const createSmtpMailer = (config?: SmtpMailerConfig): SmtpMailer | DummyMailer => {\n    /**\n     * If we have environment variables, use those as config.\n     */\n    if (variables.host && variables.user && variables.password) {\n        if (config) {\n            throw new WebinyError({\n                message: `Cannot use both config and environment variables to setup the nodemailer.`,\n                code: \"SMTP_MAILER_INIT_ERROR\"\n            });\n        }\n        config = {\n            host: variables.host,\n            auth: {\n                user: variables.user,\n                pass: variables.password\n            }\n        };\n    } else if (!config) {\n        console.log(\n            \"There is no config or required environment variables defined. Using dummy mailer.\"\n        );\n        return createDummyMailer();\n    }\n    const transporter = nodemailer.createTransport({\n        ...config\n    });\n\n    return {\n        transporter,\n        send: async params => {\n            const { replyTo, text, html, to, bcc, cc, from, subject } = params;\n\n            try {\n                const result = await transporter.sendMail({\n                    replyTo,\n                    bcc,\n                    cc,\n                    from,\n                    text,\n                    html,\n                    to,\n                    subject\n                });\n                if (result.messageId) {\n                    return {\n                        result: true,\n                        error: null\n                    };\n                }\n\n                throw new WebinyError({\n                    message:\n                        \"nodemailer.sendMail does not have a messageId in the result. Something went wrong...\",\n                    code: \"MAILER_ERROR\",\n                    data: {\n                        ...result\n                    }\n                });\n            } catch (ex) {\n                return {\n                    result: null,\n                    error: {\n                        message: ex.message,\n                        code: ex.code,\n                        data: {\n                            ...params,\n                            ...ex.data\n                        }\n                    }\n                };\n            }\n        }\n    };\n};\n"],"mappings":";;;;;;;;;;;AAKA;;AACA;;AAEA;;;;;;AAaA,MAAMA,SAAyC,GAAG;EAC9CC,IAAI,EAAEC,OAAO,CAACC,GAAR,CAAYC,kBAD4B;EAE9CC,IAAI,EAAEH,OAAO,CAACC,GAAR,CAAYG,kBAF4B;EAG9CC,QAAQ,EAAEL,OAAO,CAACC,GAAR,CAAYK;AAHwB,CAAlD;;AAMO,MAAMC,gBAAgB,GAAIC,MAAD,IAAyD;EACrF;AACJ;AACA;EACI,IAAIV,SAAS,CAACC,IAAV,IAAkBD,SAAS,CAACK,IAA5B,IAAoCL,SAAS,CAACO,QAAlD,EAA4D;IACxD,IAAIG,MAAJ,EAAY;MACR,MAAM,IAAIC,cAAJ,CAAgB;QAClBC,OAAO,EAAG,2EADQ;QAElBC,IAAI,EAAE;MAFY,CAAhB,CAAN;IAIH;;IACDH,MAAM,GAAG;MACLT,IAAI,EAAED,SAAS,CAACC,IADX;MAELa,IAAI,EAAE;QACFT,IAAI,EAAEL,SAAS,CAACK,IADd;QAEFU,IAAI,EAAEf,SAAS,CAACO;MAFd;IAFD,CAAT;EAOH,CAdD,MAcO,IAAI,CAACG,MAAL,EAAa;IAChBM,OAAO,CAACC,GAAR,CACI,mFADJ;IAGA,OAAO,IAAAC,oCAAA,GAAP;EACH;;EACD,MAAMC,WAAW,GAAGC,mBAAA,CAAWC,eAAX,mBACbX,MADa,EAApB;;EAIA,OAAO;IACHS,WADG;IAEHG,IAAI,EAAE,MAAMC,MAAN,IAAgB;MAClB,MAAM;QAAEC,OAAF;QAAWC,IAAX;QAAiBC,IAAjB;QAAuBC,EAAvB;QAA2BC,GAA3B;QAAgCC,EAAhC;QAAoCC,IAApC;QAA0CC;MAA1C,IAAsDR,MAA5D;;MAEA,IAAI;QACA,MAAMS,MAAM,GAAG,MAAMb,WAAW,CAACc,QAAZ,CAAqB;UACtCT,OADsC;UAEtCI,GAFsC;UAGtCC,EAHsC;UAItCC,IAJsC;UAKtCL,IALsC;UAMtCC,IANsC;UAOtCC,EAPsC;UAQtCI;QARsC,CAArB,CAArB;;QAUA,IAAIC,MAAM,CAACE,SAAX,EAAsB;UAClB,OAAO;YACHF,MAAM,EAAE,IADL;YAEHG,KAAK,EAAE;UAFJ,CAAP;QAIH;;QAED,MAAM,IAAIxB,cAAJ,CAAgB;UAClBC,OAAO,EACH,sFAFc;UAGlBC,IAAI,EAAE,cAHY;UAIlBuB,IAAI,oBACGJ,MADH;QAJc,CAAhB,CAAN;MAQH,CA1BD,CA0BE,OAAOK,EAAP,EAAW;QACT,OAAO;UACHL,MAAM,EAAE,IADL;UAEHG,KAAK,EAAE;YACHvB,OAAO,EAAEyB,EAAE,CAACzB,OADT;YAEHC,IAAI,EAAEwB,EAAE,CAACxB,IAFN;YAGHuB,IAAI,kCACGb,MADH,GAEGc,EAAE,CAACD,IAFN;UAHD;QAFJ,CAAP;MAWH;IACJ;EA5CE,CAAP;AA8CH,CA1EM"}

package/package.json

@@ -0,0 +1,47 @@
+{
+	"name": "@webiny/api-mailer",
+	"version": "5.30.0-beta.0",
+	"main": "index.js",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git",
+		"directory": "packages/api-mailer"
+	},
+	"keywords": [
+		"mailer:base"
+	],
+	"author": "Webiny Ltd",
+	"description": "The API to send e-mails.",
+	"license": "MIT",
+	"dependencies": {
+		"@babel/runtime": "7.18.6",
+		"@webiny/error": "5.30.0-beta.0",
+		"@webiny/handler": "5.30.0-beta.0",
+		"@webiny/plugins": "5.30.0-beta.0",
+		"@webiny/pubsub": "5.30.0-beta.0",
+		"joi": "17.6.0",
+		"nodemailer": "6.7.7"
+	},
+	"devDependencies": {
+		"@babel/cli": "^7.16.0",
+		"@babel/core": "^7.16.0",
+		"@babel/preset-env": "^7.16.4",
+		"@babel/preset-typescript": "^7.16.0",
+		"@types/nodemailer": "^6.4.4",
+		"@webiny/cli": "^5.30.0-beta.0",
+		"@webiny/project-utils": "^5.30.0-beta.0",
+		"jest": "^26.6.3",
+		"rimraf": "^3.0.2",
+		"ttypescript": "^1.5.12",
+		"typescript": "4.7.4"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "dist"
+	},
+	"scripts": {
+		"build": "yarn webiny run build",
+		"watch": "yarn webiny run watch"
+	},
+	"gitHead": "622d120f5637e3ca807b8bfc9ed2cd034ac85fb7"
+}

package/types.d.ts

@@ -0,0 +1,59 @@
+import { Context } from "@webiny/handler/types";
+import { Topic } from "@webiny/pubsub/types";
+export interface MailerContextObjectSendParams {
+    data: MailerSendData;
+}
+export declare type MailerSetterParams = Mailer | (() => Promise<Mailer>);
+export interface MailerSetter {
+    (mailer: MailerSetterParams): void;
+}
+export interface MailerContextObject {
+    onBeforeSend: Topic<OnBeforeMailerSendParams>;
+    onAfterSend: Topic<OnAfterMailerSendParams>;
+    onError: Topic<OnErrorMailerParams>;
+    setMailer: MailerSetter;
+    getMailer: <T extends Mailer = Mailer>() => Promise<T>;
+    send: <T>(params: MailerContextObjectSendParams) => Promise<MailerSendResponse<T>>;
+}
+export interface MailerContext extends Context {
+    mailer: MailerContextObject;
+}
+export interface MailerConfig<T extends Mailer = Mailer> {
+    mailer?: T;
+}
+export interface OnBeforeMailerSendParams {
+    data: MailerSendData;
+}
+export interface OnAfterMailerSendParams {
+    data: MailerSendData;
+}
+export interface OnErrorMailerParams {
+    error: Error;
+    data: MailerSendData;
+}
+/**
+ * Interface to implement the actual mailer.
+ */
+export interface MailerSendResponse<T = any> {
+    result: T | null;
+    error: {
+        message: string;
+        code: string;
+        data: {
+            [key: string]: any;
+        };
+    } | null;
+}
+export interface MailerSendData {
+    to: string[];
+    from: string;
+    subject: string;
+    text: string;
+    html?: string;
+    replyTo?: string;
+    cc?: string[];
+    bcc?: string[];
+}
+export interface Mailer<T = any> {
+    send: (params: MailerSendData) => Promise<MailerSendResponse<T>>;
+}

package/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import { Context } from \"@webiny/handler/types\";\nimport { Topic } from \"@webiny/pubsub/types\";\n\nexport interface MailerContextObjectSendParams {\n    data: MailerSendData;\n}\n\nexport type MailerSetterParams = Mailer | (() => Promise<Mailer>);\n\nexport interface MailerSetter {\n    (mailer: MailerSetterParams): void;\n}\n\nexport interface MailerContextObject {\n    onBeforeSend: Topic<OnBeforeMailerSendParams>;\n    onAfterSend: Topic<OnAfterMailerSendParams>;\n    onError: Topic<OnErrorMailerParams>;\n    setMailer: MailerSetter;\n    getMailer: <T extends Mailer = Mailer>() => Promise<T>;\n    send: <T>(params: MailerContextObjectSendParams) => Promise<MailerSendResponse<T>>;\n}\nexport interface MailerContext extends Context {\n    mailer: MailerContextObject;\n}\n\nexport interface MailerConfig<T extends Mailer = Mailer> {\n    mailer?: T;\n}\n\nexport interface OnBeforeMailerSendParams {\n    data: MailerSendData;\n}\nexport interface OnAfterMailerSendParams {\n    data: MailerSendData;\n}\nexport interface OnErrorMailerParams {\n    error: Error;\n    data: MailerSendData;\n}\n\n/**\n * Interface to implement the actual mailer.\n */\nexport interface MailerSendResponse<T = any> {\n    result: T | null;\n    error: {\n        message: string;\n        code: string;\n        data: {\n            [key: string]: any;\n        };\n    } | null;\n}\n\nexport interface MailerSendData {\n    to: string[];\n    from: string;\n    subject: string;\n    text: string;\n    html?: string;\n    replyTo?: string;\n    cc?: string[];\n    bcc?: string[];\n}\nexport interface Mailer<T = any> {\n    send: (params: MailerSendData) => Promise<MailerSendResponse<T>>;\n}\n"],"mappings":""}