@nestjs-modules/mailer 2.0.0 → 2.0.1

package/.env

@@ -0,0 +1,2 @@
+EMAIL_ID=example@example.com
+EMAIL_PASS=your-email-password

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [2.0.1](https://github.com/nest-modules/mailer/compare/v2.0.0...v2.0.1) (2024-04-30)
+
 ## [2.0.0](https://github.com/nest-modules/mailer/compare/v1.11.2...v2.0.0) (2024-04-27)
 
 

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

@@ -0,0 +1,8 @@
+import { MailerOptions } from '../interfaces/mailer-options.interface';
+import { TemplateAdapter } from '../interfaces/template-adapter.interface';
+import { Liquid } from 'liquidjs';
+export declare class LiquidAdapter implements TemplateAdapter {
+    private config;
+    constructor(config?: Partial<Liquid['options']>);
+    compile(mail: any, callback: any, mailerOptions: MailerOptions): void;
+}

package/dist/adapters/liquid.adapter.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LiquidAdapter = void 0;
+const path = require("path");
+const lodash_1 = require("lodash");
+const liquidjs_1 = require("liquidjs");
+class LiquidAdapter {
+    constructor(config) {
+        Object.assign(this.config, config);
+    }
+    compile(mail, callback, mailerOptions) {
+        const { context, template } = mail.data;
+        const templateExt = path.extname(template) || '.liquid';
+        const templateName = path.basename(template, path.extname(template));
+        const templateDir = path.isAbsolute(template)
+            ? path.dirname(template)
+            : path.join((0, lodash_1.get)(mailerOptions, 'template.dir', ''), path.dirname(template));
+        const engine = new liquidjs_1.Liquid(Object.assign({ extname: templateExt, root: templateDir }, this.config.globals));
+        engine.renderFile(templateName, context).then((body) => {
+            mail.data.html = body;
+            return callback();
+        }).catch((err) => {
+            return callback(err);
+        });
+    }
+}
+exports.LiquidAdapter = LiquidAdapter;

package/dist/adapters/mjml.adapter.js

@@ -4,7 +4,7 @@ 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 mjml2html = require("mjml");
+const mjml_1 = require("mjml");
 class MjmlAdapter {
     constructor(engine, config, others) {
         this.engine = engine;
@@ -26,7 +26,7 @@ class MjmlAdapter {
     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 = mjml2html(mail.data.html).html;
+            mail.data.html = (0, mjml_1.default)(mail.data.html).html;
             callback();
         }, mailerOptions);
     }

package/dist/interfaces/mailer-options.interface.d.ts

@@ -31,5 +31,6 @@ export interface MailerOptions {
             app: string | string[];
         };
     }>;
+    verifyTransporters?: boolean;
 }
 export {};

package/dist/mailer.service.d.ts

@@ -12,7 +12,11 @@ export declare class MailerService {
     private initTemplateAdapter;
     private readonly mailerLogger;
     constructor(mailerOptions: MailerOptions, transportFactory: IMailerTransportFactory);
+    private validateTransportOptions;
+    private createTransporter;
+    private setupTransporters;
     private verifyTransporter;
+    verifyAllTransporters(): Promise<boolean>;
     sendMail(sendMailOptions: ISendMailOptions): Promise<SentMessageInfo>;
     addTransporter(transporterName: string, config: string | smtpTransport | smtpTransport.Options): string;
 }

package/dist/mailer.service.js

@@ -5,7 +5,6 @@ exports.MailerService = void 0;
 const tslib_1 = require("tslib");
 const lodash_1 = require("lodash");
 const common_1 = require("@nestjs/common");
-const previewEmail = require("preview-email");
 const mailer_constant_1 = require("./constants/mailer.constant");
 const mailer_transport_factory_1 = require("./mailer-transport.factory");
 let MailerService = MailerService_1 = class MailerService {
@@ -17,11 +16,24 @@ let MailerService = MailerService_1 = class MailerService {
                 }
                 return templateAdapter.compile(mail, callback, this.mailerOptions);
             });
+            let previewEmail;
+            try {
+                previewEmail = require('preview-email');
+            }
+            catch (err) {
+                this.mailerLogger.warn('preview-email is not installed. This is an optional dependency. Install it if you want to preview emails in the development environment. You can install it using npm (npm install preview-email), yarn (yarn add preview-email), or pnpm (pnpm add preview-email).');
+            }
             if (this.mailerOptions.preview) {
                 transporter.use('stream', (mail, callback) => {
-                    return previewEmail(mail.data, this.mailerOptions.preview)
-                        .then(() => callback())
-                        .catch(callback);
+                    if (typeof previewEmail !== 'undefined') {
+                        return previewEmail(mail.data, this.mailerOptions.preview)
+                            .then(() => callback())
+                            .catch(callback);
+                    }
+                    else {
+                        this.mailerLogger.warn('previewEmail is not available. Skipping preview.');
+                        return callback();
+                    }
                 });
             }
         }
@@ -34,11 +46,7 @@ let MailerService = MailerService_1 = class MailerService {
         if (!transportFactory) {
             this.transportFactory = new mailer_transport_factory_1.MailerTransportFactory(mailerOptions);
         }
-        if ((!mailerOptions.transport ||
-            Object.keys(mailerOptions.transport).length <= 0) &&
-            !mailerOptions.transports) {
-            throw new Error('Make sure to provide a nodemailer transport configuration object, connection url or a transport plugin instance.');
-        }
+        this.validateTransportOptions();
         this.templateAdapter = (0, lodash_1.get)(this.mailerOptions, 'template.adapter');
         if (this.mailerOptions.preview) {
             const defaults = { open: { wait: false } };
@@ -47,25 +55,51 @@ let MailerService = MailerService_1 = class MailerService {
                     ? defaults
                     : (0, lodash_1.defaultsDeep)(this.mailerOptions.preview, defaults);
         }
-        if (mailerOptions.transports) {
-            Object.keys(mailerOptions.transports).forEach((name) => {
-                const transporter = this.transportFactory.createTransport(this.mailerOptions.transports[name]);
+        this.setupTransporters();
+    }
+    validateTransportOptions() {
+        if ((!this.mailerOptions.transport ||
+            Object.keys(this.mailerOptions.transport).length <= 0) &&
+            !this.mailerOptions.transports) {
+            throw new Error('Make sure to provide a nodemailer transport configuration object, connection url or a transport plugin instance.');
+        }
+    }
+    createTransporter(config, name) {
+        const transporter = this.transportFactory.createTransport(config);
+        if (this.mailerOptions.verifyTransporters)
+            this.verifyTransporter(transporter, name);
+        this.initTemplateAdapter(this.templateAdapter, transporter);
+        return transporter;
+    }
+    setupTransporters() {
+        if (this.mailerOptions.transports) {
+            Object.keys(this.mailerOptions.transports).forEach((name) => {
+                const transporter = this.createTransporter(this.mailerOptions.transports[name], name);
                 this.transporters.set(name, transporter);
-                this.verifyTransporter(transporter, name);
-                this.initTemplateAdapter(this.templateAdapter, transporter);
             });
         }
-        if (mailerOptions.transport) {
-            this.transporter = this.transportFactory.createTransport();
-            this.verifyTransporter(this.transporter);
-            this.initTemplateAdapter(this.templateAdapter, this.transporter);
+        if (this.mailerOptions.transport) {
+            this.transporter = this.createTransporter(this.mailerOptions.transport);
         }
     }
     verifyTransporter(transporter, name) {
         const transporterName = name ? ` '${name}'` : '';
-        transporter.verify()
-            .then(() => this.mailerLogger.error(`Transporter${transporterName} is ready`))
-            .catch((error) => this.mailerLogger.error(`Error occurred while verifying the transporter${transporterName}}: ${error.message}`));
+        if (!transporter.verify)
+            return;
+        Promise.resolve(transporter.verify())
+            .then(() => this.mailerLogger.debug(`Transporter${transporterName} is ready`))
+            .catch((error) => this.mailerLogger.error(`Error occurred while verifying the transporter${transporterName}: ${error.message}`));
+    }
+    verifyAllTransporters() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const transporters = [...this.transporters.values(), this.transporter];
+            const transportersVerified = yield Promise.all(transporters.map(transporter => {
+                if (!transporter.verify)
+                    return true;
+                return Promise.resolve(transporter.verify()).then(() => true).catch(() => false);
+            }));
+            return transportersVerified.every(verified => verified);
+        });
     }
     sendMail(sendMailOptions) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs-modules/mailer",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "private": false,
   "description": "NestJS - a mailer module (@mailer)",
   "keywords": [