@nestjs-modules/mailer 1.5.1 → 1.7.0

package/README.md

@@ -1,64 +1,66 @@
-<p align="center">
-  <a href="http://nestjs.com/" target="blank">
-    <img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" />
-  </a>
-</p>
-
-<p align="center">
-  A mailer module for Nest framework (node.js) using <a href="https://nodemailer.com/">Nodemailer</a> library
-</p>
-
-<p align="center">
-  <a href="https://www.npmjs.com/org/nestjs-modules"><img src="https://img.shields.io/npm/v/@nestjs-modules/mailer.svg" alt="NPM Version" /></a>
-  <a href="https://www.npmjs.com/org/nestjs-modules"><img src="https://img.shields.io/npm/l/@nestjs-modules/mailer.svg" alt="Package License" /></a>
-  <a href="https://www.npmjs.com/org/nestjs-modules"><img src="https://img.shields.io/npm/dm/@nestjs-modules/mailer.svg" alt="NPM Downloads" /></a>
-  <a href="https://opencollective.com/nest-modules#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
-</p>
-
-### Installation
-
-```sh
-npm install --save @nestjs-modules/mailer nodemailer
-#or
-yarn add @nestjs-modules/mailer nodemailer
-```
-
-**Hint:** handlebars and pug is an optional dependency, if you want to use the template, you must install it.
-
-#### with npm
-```sh
-npm install --save handlebars
-#or
-npm install --save pug
-#or
-npm install --save ejs
-```
-
-#### with yarn
-```sh
-yarn add handlebars
-#or
-yarn add pug
-#or
-yarn add ejs
-```
-
-### Documentation
-
-you can find all the documentation [here](https://nest-modules.github.io/mailer/) for the email module
-
-### Starter kit
-
-- [Sending email-template with outlook](https://github.com/yanarp/nestjs-mailer) - Starter kit, nestjs mailer implementation on outlook smtp with email-template
-
-### Contributing
-
-* [Cristiam Diaz](https://github.com/cdiaz)
-* [Eduardo Leal](https://github.com/eduardoleal)
-* [Juan Echeverry](https://github.com/juandav)
-* [Pat McGowan](https://github.com/p-mcgowan)
-* [Paweł Partyka](https://github.com/partyka95)
-
-### License
-
-MIT
+<p align="center">
+  <a href="http://nestjs.com/" target="blank">
+    <img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" />
+  </a>
+</p>
+
+<p align="center">
+  A mailer module for Nest framework (node.js) using <a href="https://nodemailer.com/">Nodemailer</a> library
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/org/nestjs-modules"><img src="https://img.shields.io/npm/v/@nestjs-modules/mailer.svg" alt="NPM Version" /></a>
+  <a href="https://www.npmjs.com/org/nestjs-modules"><img src="https://img.shields.io/npm/l/@nestjs-modules/mailer.svg" alt="Package License" /></a>
+  <a href="https://www.npmjs.com/org/nestjs-modules"><img src="https://img.shields.io/npm/dm/@nestjs-modules/mailer.svg" alt="NPM Downloads" /></a>
+  <a href="https://opencollective.com/nest-modules#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
+</p>
+
+### Installation
+
+```sh
+npm install --save @nestjs-modules/mailer nodemailer
+npm install --save-dev @types/nodemailer
+#or
+yarn add @nestjs-modules/mailer nodemailer
+yarn add -D @types/nodemailer
+```
+
+**Hint:** handlebars and pug is an optional dependency, if you want to use the template, you must install it.
+
+#### with npm
+```sh
+npm install --save handlebars
+#or
+npm install --save pug
+#or
+npm install --save ejs
+```
+
+#### with yarn
+```sh
+yarn add handlebars
+#or
+yarn add pug
+#or
+yarn add ejs
+```
+
+### Documentation
+
+you can find all the documentation [here](https://nest-modules.github.io/mailer/) for the email module
+
+### Starter kit
+
+- [Sending email-template with outlook](https://github.com/yanarp/nestjs-mailer) - Starter kit, nestjs mailer implementation on outlook smtp with email-template
+
+### Contributing
+
+* [Cristiam Diaz](https://github.com/cdiaz)
+* [Eduardo Leal](https://github.com/eduardoleal)
+* [Juan Echeverry](https://github.com/juandav)
+* [Pat McGowan](https://github.com/p-mcgowan)
+* [Paweł Partyka](https://github.com/partyka95)
+
+### License
+
+MIT

package/SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.

package/dist/adapters/ejs.adapter.d.ts

@@ -1,6 +1,9 @@
-import { MailerOptions } from '../interfaces/mailer-options.interface';
-import { TemplateAdapter } from '../interfaces/template-adapter.interface';
-export declare class EjsAdapter implements TemplateAdapter {
-    private precompiledTemplates;
-    compile(mail: any, callback: any, mailerOptions: MailerOptions): void;
-}
+import { MailerOptions } from '../interfaces/mailer-options.interface';
+import { TemplateAdapter } from '../interfaces/template-adapter.interface';
+import { TemplateAdapterConfig } from '../interfaces/template-adapter-config.interface';
+export declare class EjsAdapter implements TemplateAdapter {
+    private precompiledTemplates;
+    private config;
+    constructor(config?: TemplateAdapterConfig);
+    compile(mail: any, callback: any, mailerOptions: MailerOptions): void;
+}

package/dist/adapters/ejs.adapter.js

@@ -1,43 +1,58 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ejs_1 = require("ejs");
-const lodash_1 = require("lodash");
-const fs = require("fs");
-const path = require("path");
-const inlineCss = require("inline-css");
-class EjsAdapter {
-    constructor() {
-        this.precompiledTemplates = {};
-    }
-    compile(mail, callback, mailerOptions) {
-        const templateExt = path.extname(mail.data.template) || '.ejs';
-        const templateName = path.basename(mail.data.template, path.extname(mail.data.template));
-        const templateDir = path.dirname(mail.data.template) !== '.'
-            ? path.dirname(mail.data.template)
-            : lodash_1.get(mailerOptions, 'template.dir', '');
-        const templatePath = path.join(templateDir, templateName + templateExt);
-        if (!this.precompiledTemplates[templateName]) {
-            try {
-                const template = fs.readFileSync(templatePath, 'UTF-8');
-                this.precompiledTemplates[templateName] = ejs_1.compile(template, Object.assign(Object.assign({}, lodash_1.get(mailerOptions, 'template.options', {})), { filename: templatePath }));
-            }
-            catch (err) {
-                return callback(err);
-            }
-        }
-        const rendered = this.precompiledTemplates[templateName](mail.data.context);
-        const render = (html) => {
-            inlineCss(html, { url: ' ' }).then((html) => {
-                mail.data.html = html;
-                return callback();
-            });
-        };
-        if (typeof rendered === 'string') {
-            render(rendered);
-        }
-        else {
-            rendered.then(render);
-        }
-    }
-}
-exports.EjsAdapter = EjsAdapter;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EjsAdapter = void 0;
+const ejs_1 = require("ejs");
+const lodash_1 = require("lodash");
+const fs = require("fs");
+const path = require("path");
+const inlineCss = require("inline-css");
+class EjsAdapter {
+    constructor(config) {
+        this.precompiledTemplates = {};
+        this.config = {
+            inlineCssOptions: { url: ' ' },
+            inlineCssEnabled: true,
+        };
+        Object.assign(this.config, config);
+    }
+    compile(mail, callback, mailerOptions) {
+        const { context, template } = mail.data;
+        const templateExt = path.extname(template) || '.ejs';
+        const templateName = path.basename(template, path.extname(template));
+        const templateDir = path.isAbsolute(template)
+            ? path.dirname(template)
+            : path.join(lodash_1.get(mailerOptions, 'template.dir', ''), path.dirname(template));
+        const templatePath = path.join(templateDir, templateName + templateExt);
+        if (!this.precompiledTemplates[templateName]) {
+            try {
+                const template = fs.readFileSync(templatePath, 'utf-8');
+                this.precompiledTemplates[templateName] = ejs_1.compile(template, Object.assign(Object.assign({}, lodash_1.get(mailerOptions, 'template.options', {})), { filename: templatePath }));
+            }
+            catch (err) {
+                return callback(err);
+            }
+        }
+        const rendered = this.precompiledTemplates[templateName](context);
+        const render = (html) => {
+            if (this.config.inlineCssEnabled) {
+                inlineCss(html, this.config.inlineCssOptions)
+                    .then((html) => {
+                    mail.data.html = html;
+                    return callback();
+                })
+                    .catch(callback);
+            }
+            else {
+                mail.data.html = html;
+                return callback();
+            }
+        };
+        if (typeof rendered === 'string') {
+            render(rendered);
+        }
+        else {
+            rendered.then(render);
+        }
+    }
+}
+exports.EjsAdapter = EjsAdapter;

package/dist/adapters/handlebars.adapter.d.ts

@@ -1,8 +1,10 @@
-import { HelperDeclareSpec } from 'handlebars';
-import { MailerOptions } from '../interfaces/mailer-options.interface';
-import { TemplateAdapter } from '../interfaces/template-adapter.interface';
-export declare class HandlebarsAdapter implements TemplateAdapter {
-    private precompiledTemplates;
-    constructor(helpers?: HelperDeclareSpec);
-    compile(mail: any, callback: any, mailerOptions: MailerOptions): void;
-}
+import { HelperDeclareSpec } from 'handlebars';
+import { MailerOptions } from '../interfaces/mailer-options.interface';
+import { TemplateAdapter } from '../interfaces/template-adapter.interface';
+import { TemplateAdapterConfig } from '../interfaces/template-adapter-config.interface';
+export declare class HandlebarsAdapter implements TemplateAdapter {
+    private precompiledTemplates;
+    private config;
+    constructor(helpers?: HelperDeclareSpec, config?: TemplateAdapterConfig);
+    compile(mail: any, callback: any, mailerOptions: MailerOptions): void;
+}

package/dist/adapters/handlebars.adapter.js

@@ -1,58 +1,76 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs");
-const path = require("path");
-const handlebars = require("handlebars");
-const inlineCss = require("inline-css");
-const glob = require("glob");
-const lodash_1 = require("lodash");
-class HandlebarsAdapter {
-    constructor(helpers) {
-        this.precompiledTemplates = {};
-        handlebars.registerHelper('concat', (...args) => {
-            args.pop();
-            return args.join('');
-        });
-        handlebars.registerHelper(helpers || {});
-    }
-    compile(mail, callback, mailerOptions) {
-        const precompile = (template, callback, options) => {
-            const templateExt = path.extname(template) || '.hbs';
-            const templateName = path.basename(template, path.extname(template));
-            const templateDir = path.dirname(template) !== '.'
-                ? path.dirname(template)
-                : lodash_1.get(options, 'dir', '');
-            const templatePath = path.join(templateDir, templateName + templateExt);
-            if (!this.precompiledTemplates[templateName]) {
-                try {
-                    const template = fs.readFileSync(templatePath, 'UTF-8');
-                    this.precompiledTemplates[templateName] = handlebars.compile(template, lodash_1.get(options, 'options', {}));
-                }
-                catch (err) {
-                    return callback(err);
-                }
-            }
-            return {
-                templateExt,
-                templateName,
-                templateDir,
-                templatePath,
-            };
-        };
-        const { templateName } = precompile(mail.data.template, callback, mailerOptions.template);
-        const runtimeOptions = lodash_1.get(mailerOptions, 'options', {
-            partials: false,
-            data: {},
-        });
-        if (runtimeOptions.partials) {
-            const files = glob.sync(path.join(runtimeOptions.partials.dir, '*.hbs'));
-            files.forEach((file) => precompile(file, () => { }, runtimeOptions.partials));
-        }
-        const rendered = this.precompiledTemplates[templateName](mail.data.context, Object.assign(Object.assign({}, runtimeOptions), { partials: this.precompiledTemplates }));
-        inlineCss(rendered, { url: ' ' }).then((html) => {
-            mail.data.html = html;
-            return callback();
-        });
-    }
-}
-exports.HandlebarsAdapter = HandlebarsAdapter;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HandlebarsAdapter = void 0;
+const fs = require("fs");
+const path = require("path");
+const handlebars = require("handlebars");
+const inlineCss = require("inline-css");
+const glob = require("glob");
+const lodash_1 = require("lodash");
+class HandlebarsAdapter {
+    constructor(helpers, config) {
+        this.precompiledTemplates = {};
+        this.config = {
+            inlineCssOptions: { url: ' ' },
+            inlineCssEnabled: true,
+        };
+        handlebars.registerHelper('concat', (...args) => {
+            args.pop();
+            return args.join('');
+        });
+        handlebars.registerHelper(helpers || {});
+        Object.assign(this.config, config);
+    }
+    compile(mail, callback, mailerOptions) {
+        const precompile = (template, callback, options) => {
+            const templateExt = path.extname(template) || '.hbs';
+            const templateName = path.basename(template, path.extname(template));
+            const templateDir = path.isAbsolute(template)
+                ? path.dirname(template)
+                : path.join(lodash_1.get(options, 'dir', ''), path.dirname(template));
+            const templatePath = path.join(templateDir, templateName + templateExt);
+            if (!this.precompiledTemplates[templateName]) {
+                try {
+                    const template = fs.readFileSync(templatePath, 'utf-8');
+                    this.precompiledTemplates[templateName] = handlebars.compile(template, lodash_1.get(options, 'options', {}));
+                }
+                catch (err) {
+                    return callback(err);
+                }
+            }
+            return {
+                templateExt,
+                templateName,
+                templateDir,
+                templatePath,
+            };
+        };
+        const { templateName } = precompile(mail.data.template, callback, mailerOptions.template);
+        const runtimeOptions = lodash_1.get(mailerOptions, 'options', {
+            partials: false,
+            data: {},
+        });
+        if (runtimeOptions.partials) {
+            const files = glob.sync(path.join(runtimeOptions.partials.dir, '**', '*.hbs'));
+            files.forEach((file) => {
+                const { templateName, templatePath } = precompile(file, () => { }, runtimeOptions.partials);
+                const templateDir = path.relative(runtimeOptions.partials.dir, path.dirname(templatePath));
+                handlebars.registerPartial(path.join(templateDir, templateName), fs.readFileSync(templatePath, 'utf-8'));
+            });
+        }
+        const rendered = this.precompiledTemplates[templateName](mail.data.context, Object.assign(Object.assign({}, runtimeOptions), { partials: this.precompiledTemplates }));
+        if (this.config.inlineCssEnabled) {
+            inlineCss(rendered, this.config.inlineCssOptions)
+                .then((html) => {
+                mail.data.html = html;
+                return callback();
+            })
+                .catch(callback);
+        }
+        else {
+            mail.data.html = rendered;
+            return callback();
+        }
+    }
+}
+exports.HandlebarsAdapter = HandlebarsAdapter;

package/dist/adapters/mjml.adapter.d.ts

@@ -0,0 +1,12 @@
+import { TemplateAdapterConfig } from "../interfaces/template-adapter-config.interface";
+import { TemplateAdapter } from "../interfaces/template-adapter.interface";
+import { MailerOptions } from "../interfaces/mailer-options.interface";
+export declare class MjmlAdapter implements TemplateAdapter {
+    private engine;
+    constructor(engine: TemplateAdapter | "" | "pug" | "handlebars" | "ejs", config?: TemplateAdapterConfig, others?: {
+        handlebar?: {
+            helper?: any;
+        };
+    });
+    compile(mail: any, callback: any, mailerOptions: MailerOptions): void;
+}

package/dist/adapters/mjml.adapter.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MjmlAdapter = void 0;
+const handlebars_adapter_1 = require("./handlebars.adapter");
+const ejs_adapter_1 = require("./ejs.adapter");
+const pug_adapter_1 = require("./pug.adapter");
+const mjml_1 = require("mjml");
+class MjmlAdapter {
+    constructor(engine, config, others) {
+        this.engine = engine;
+        if (typeof engine == "string") {
+            if (engine === "pug") {
+                this.engine = new pug_adapter_1.PugAdapter(config);
+            }
+            else if (engine === "handlebars") {
+                this.engine = new handlebars_adapter_1.HandlebarsAdapter(others.handlebar.helper, config);
+            }
+            else if (engine === "ejs") {
+                this.engine = new ejs_adapter_1.EjsAdapter(config);
+            }
+            else if (engine === "") {
+                engine = null;
+            }
+        }
+    }
+    compile(mail, callback, mailerOptions) {
+        var _a;
+        (_a = this === null || this === void 0 ? void 0 : this.engine) === null || _a === void 0 ? void 0 : _a.compile(mail, () => {
+            mail.data.html = mjml_1.default(mail.data.html).html;
+            callback();
+        }, mailerOptions);
+    }
+}
+exports.MjmlAdapter = MjmlAdapter;

package/dist/adapters/pug.adapter.d.ts

@@ -1,5 +1,8 @@
-import { MailerOptions } from '../interfaces/mailer-options.interface';
-import { TemplateAdapter } from '../interfaces/template-adapter.interface';
-export declare class PugAdapter implements TemplateAdapter {
-    compile(mail: any, callback: any, mailerOptions: MailerOptions): void;
-}
+import { MailerOptions } from '../interfaces/mailer-options.interface';
+import { TemplateAdapter } from '../interfaces/template-adapter.interface';
+import { TemplateAdapterConfig } from '../interfaces/template-adapter-config.interface';
+export declare class PugAdapter implements TemplateAdapter {
+    private config;
+    constructor(config?: TemplateAdapterConfig);
+    compile(mail: any, callback: any, mailerOptions: MailerOptions): void;
+}

package/dist/adapters/pug.adapter.js

@@ -1,27 +1,44 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const path = require("path");
-const lodash_1 = require("lodash");
-const pug_1 = require("pug");
-const inlineCss = require("inline-css");
-class PugAdapter {
-    compile(mail, callback, mailerOptions) {
-        const templateExt = path.extname(mail.data.template) || '.pug';
-        const templateName = path.basename(mail.data.template, path.extname(mail.data.template));
-        const templateDir = path.dirname(mail.data.template) !== '.'
-            ? path.dirname(mail.data.template)
-            : lodash_1.get(mailerOptions, 'template.dir', '');
-        const templatePath = path.join(templateDir, templateName + templateExt);
-        const options = Object.assign(Object.assign({}, mail.data.context), lodash_1.get(mailerOptions, 'template.options', {}));
-        pug_1.renderFile(templatePath, options, (err, body) => {
-            if (err) {
-                return callback(err);
-            }
-            inlineCss(body, { url: ' ' }).then((html) => {
-                mail.data.html = html;
-                return callback();
-            });
-        });
-    }
-}
-exports.PugAdapter = PugAdapter;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PugAdapter = void 0;
+const path = require("path");
+const lodash_1 = require("lodash");
+const pug_1 = require("pug");
+const inlineCss = require("inline-css");
+class PugAdapter {
+    constructor(config) {
+        this.config = {
+            inlineCssOptions: { url: ' ' },
+            inlineCssEnabled: true,
+        };
+        Object.assign(this.config, config);
+    }
+    compile(mail, callback, mailerOptions) {
+        const { context, template } = mail.data;
+        const templateExt = path.extname(template) || '.pug';
+        const templateName = path.basename(template, path.extname(template));
+        const templateDir = path.isAbsolute(template)
+            ? path.dirname(template)
+            : path.join(lodash_1.get(mailerOptions, 'template.dir', ''), path.dirname(template));
+        const templatePath = path.join(templateDir, templateName + templateExt);
+        const options = Object.assign(Object.assign({}, context), lodash_1.get(mailerOptions, 'template.options', {}));
+        pug_1.renderFile(templatePath, options, (err, body) => {
+            if (err) {
+                return callback(err);
+            }
+            if (this.config.inlineCssEnabled) {
+                inlineCss(body, this.config.inlineCssOptions)
+                    .then((html) => {
+                    mail.data.html = html;
+                    return callback();
+                })
+                    .catch(callback);
+            }
+            else {
+                mail.data.html = body;
+                return callback();
+            }
+        });
+    }
+}
+exports.PugAdapter = PugAdapter;

package/dist/constants/mailer.constant.d.ts

@@ -0,0 +1,2 @@
+export declare const MAILER_OPTIONS = "MAILER_OPTIONS";
+export declare const MAILER_TRANSPORT_FACTORY = "MAILER_TRANSPORT_FACTORY";

package/dist/constants/mailer.constant.js

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

package/dist/index.d.ts

@@ -1,6 +1,8 @@
-export { MailerModule } from './mailer.module';
-export { MailerOptions } from './interfaces/mailer-options.interface';
-export { TemplateAdapter } from './interfaces/template-adapter.interface';
-export { MailerOptionsFactory } from './interfaces/mailer-options-factory.interface';
-export { ISendMailOptions } from './interfaces/send-mail-options.interface';
-export { MailerService } from './mailer.service';
+export { MailerModule } from './mailer.module';
+export { MAILER_OPTIONS, MAILER_TRANSPORT_FACTORY, } from './constants/mailer.constant';
+export { MailerOptions } from './interfaces/mailer-options.interface';
+export { TemplateAdapter } from './interfaces/template-adapter.interface';
+export { MailerOptionsFactory } from './interfaces/mailer-options-factory.interface';
+export { ISendMailOptions } from './interfaces/send-mail-options.interface';
+export { MailerTransportFactory } from './interfaces/mailer-transport-factory.interface';
+export { MailerService } from './mailer.service';

package/dist/index.js

@@ -1,6 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var mailer_module_1 = require("./mailer.module");
-exports.MailerModule = mailer_module_1.MailerModule;
-var mailer_service_1 = require("./mailer.service");
-exports.MailerService = mailer_service_1.MailerService;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MailerService = exports.MAILER_TRANSPORT_FACTORY = exports.MAILER_OPTIONS = exports.MailerModule = void 0;
+var mailer_module_1 = require("./mailer.module");
+Object.defineProperty(exports, "MailerModule", { enumerable: true, get: function () { return mailer_module_1.MailerModule; } });
+var mailer_constant_1 = require("./constants/mailer.constant");
+Object.defineProperty(exports, "MAILER_OPTIONS", { enumerable: true, get: function () { return mailer_constant_1.MAILER_OPTIONS; } });
+Object.defineProperty(exports, "MAILER_TRANSPORT_FACTORY", { enumerable: true, get: function () { return mailer_constant_1.MAILER_TRANSPORT_FACTORY; } });
+var mailer_service_1 = require("./mailer.service");
+Object.defineProperty(exports, "MailerService", { enumerable: true, get: function () { return mailer_service_1.MailerService; } });