@qccareerschool/winston-nodemailer 3.0.0 → 4.0.0

package/.env.example

@@ -0,0 +1,6 @@
+EMAIL_USERNAME=
+EMAIL_PASSWORD=
+EMAIL_HOST=
+EMAIL_TLS=TRUE
+EMAIL_FROM=
+EMAIL_TO=

package/dist/index.d.ts

@@ -26,12 +26,6 @@ export declare class NodemailerTransport extends Transport {
     constructor(opts: INodemailerOptions);
     /**
      * log data
-     *
-     * @param  {String}   level
-     * @param  {String}   msg
-     * @param  {Object}   meta
-     * @param  {Function} cb
-     *
      */
     log(info: any, next: () => void): any;
 }

package/dist/index.js

@@ -48,12 +48,6 @@ var NodemailerTransport = /** @class */ (function (_super) {
     }
     /**
      * log data
-     *
-     * @param  {String}   level
-     * @param  {String}   msg
-     * @param  {Object}   meta
-     * @param  {Function} cb
-     *
      */
     NodemailerTransport.prototype.log = function (info, next) {
         if (this.silent) {
@@ -62,13 +56,28 @@ var NodemailerTransport = /** @class */ (function (_super) {
         if (this.filter && !this.filter(info)) {
             return next();
         }
-        if (!info.msg) {
-            info.msg = '';
+        var text;
+        if (typeof info.message === 'undefined') {
+            text = 'undefined';
         }
-        var text = info.msg.toString();
-        var subject = '' + (this.tags || '') + ("[" + info.level + "] ") + text.slice(0, 51);
-        if (info.meta) {
-            text += '\n---\n' + util.inspect(info.meta);
+        else if (typeof info.message === 'string') {
+            text = info.message;
+        }
+        else {
+            text = util.inspect(info.message);
+        }
+        var subject = (this.tags || '') + ("[" + info.level + "] ") + text.slice(0, 51);
+        var meta = {};
+        var hasMeta = false;
+        for (var _i = 0, _a = Object.keys(info); _i < _a.length; _i++) {
+            var key = _a[_i];
+            if (key !== 'message' && key !== 'level') {
+                meta[key] = info[key];
+                hasMeta = true;
+            }
+        }
+        if (hasMeta) {
+            text += '\n---\n' + util.inspect(meta);
         }
         this.smtpTransport.sendMail({
             from: this.from,

package/dist/index.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.spec.js

@@ -1 +1,58 @@
 "use strict";
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
+    result["default"] = mod;
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var dotenv = __importStar(require("dotenv"));
+var winston = __importStar(require("winston"));
+var index_1 = require("./index");
+dotenv.config();
+if (typeof process.env.EMAIL_USERNAME === 'undefined') {
+    throw new Error('EMAIL_USERNAME not specified in .env file');
+}
+var username = process.env.EMAIL_USERNAME;
+if (typeof process.env.EMAIL_PASSWORD === 'undefined') {
+    throw new Error('EMAIL_PASSWORD not specified in .env file');
+}
+var password = process.env.EMAIL_PASSWORD;
+if (typeof process.env.EMAIL_HOST === 'undefined') {
+    throw new Error('EMAIL_HOST not specified in .env file');
+}
+var host = process.env.EMAIL_HOST;
+if (typeof process.env.EMAIL_TO === 'undefined') {
+    throw new Error('EMAIL_TO not specified in .env file');
+}
+var to = process.env.EMAIL_TO;
+if (typeof process.env.EMAIL_FROM === 'undefined') {
+    throw new Error('EMAIL_FROM not specified in .env file');
+}
+var from = process.env.EMAIL_FROM;
+var logger = winston.createLogger({
+    levels: winston.config.syslog.levels,
+    transports: [
+        new index_1.NodemailerTransport({
+            auth: {
+                pass: password,
+                user: username,
+            },
+            filter: function (_a) {
+                var level = _a.level, message = _a.message, meta = _a.meta;
+                return level === 'error' || level === 'crit' || level === 'alert' || level === 'emerg';
+            },
+            format: winston.format.simple(),
+            from: from,
+            host: host,
+            port: 587,
+            secure: false,
+            tags: ['test'],
+            to: to,
+        }),
+    ],
+});
+var object = { x: [1, 2, 3], y: true, z: 32, q: { a: 1, b: 'two', c: null } };
+logger.crit('this should get logged with additional data', object);
+logger.crit(object);

package/package.json

@@ -1,30 +1,33 @@
 {
   "name": "@qccareerschool/winston-nodemailer",
-  "version": "3.0.0",
-  "description": "An email transport for winston@3 using nodemailer written in typescript.",
+  "version": "4.0.0",
+  "description": "An email transport for winston v3 using nodemailer written in typescript.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node dist/index.spec.js"
   },
   "author": "Dave Welsh",
   "license": "ISC",
   "devDependencies": {
-    "@types/chai": "^4.1.4",
+    "@types/chai": "^4.2.10",
+    "@types/dotenv": "^4.0.3",
     "@types/mocha": "^2.2.48",
-    "chai": "^4.1.2",
+    "chai": "^4.2.0",
+    "dotenv": "^6.2.0",
     "mocha": "^5.2.0",
-    "tslint": "^5.11.0",
-    "typescript": "^2.9.2",
-    "winston": "^3.0.0"
+    "tslint": "^6.0.0",
+    "typescript": "^3.8.3",
+    "winston": "^3.2.1"
   },
   "dependencies": {
-    "@types/node": "^9.6.26",
-    "@types/nodemailer": "^4.6.2",
-    "nodemailer": "^4.6.7",
-    "winston-transport": "^4.2.0"
+    "@types/node": "^13.9.0",
+    "@types/nodemailer": "^4.6.8",
+    "@types/winston": "^2.4.4",
+    "nodemailer": "^6.4.4",
+    "winston-transport": "^4.3.0"
   },
   "peerDependencies": {
-    "winston": "^3.0.0"
+    "winston": "^3.2.1"
   }
 }

package/src/index.spec.ts

@@ -0,0 +1,58 @@
+import * as dotenv from 'dotenv';
+import * as winston from 'winston';
+import { NodemailerTransport } from './index';
+
+dotenv.config();
+
+if (typeof process.env.EMAIL_USERNAME === 'undefined') {
+  throw new Error('EMAIL_USERNAME not specified in .env file');
+}
+const username = process.env.EMAIL_USERNAME;
+
+if (typeof process.env.EMAIL_PASSWORD === 'undefined') {
+  throw new Error('EMAIL_PASSWORD not specified in .env file');
+}
+const password = process.env.EMAIL_PASSWORD;
+
+if (typeof process.env.EMAIL_HOST === 'undefined') {
+  throw new Error('EMAIL_HOST not specified in .env file');
+}
+const host = process.env.EMAIL_HOST;
+
+if (typeof process.env.EMAIL_TO === 'undefined') {
+  throw new Error('EMAIL_TO not specified in .env file');
+}
+const to = process.env.EMAIL_TO;
+
+if (typeof process.env.EMAIL_FROM === 'undefined') {
+  throw new Error('EMAIL_FROM not specified in .env file');
+}
+const from = process.env.EMAIL_FROM;
+
+const logger = winston.createLogger({
+  levels: winston.config.syslog.levels,
+  transports: [
+    new NodemailerTransport({
+      auth: {
+        pass: password,
+        user: username,
+      },
+      filter: ({ level, message, meta }: any) => {
+        return level === 'error' || level === 'crit' || level === 'alert' || level === 'emerg';
+      },
+      format: winston.format.simple(),
+      from,
+      host,
+      port: 587,
+      secure: false,
+      tags: [ 'test' ],
+      to,
+    }),
+  ],
+});
+
+const object = { x: [ 1, 2, 3 ], y: true, z: 32, q: { a: 1, b: 'two', c: null } };
+
+logger.crit('this should get logged with additional data', object);
+
+logger.crit(object);

package/src/index.ts

@@ -13,14 +13,14 @@ export interface INodemailerOptions extends Transport.TransportStreamOptions {
   port: number;
   secure: boolean;
   tags?: string[];
-  to: string | Address | Array<string | Address>;
+  to: string | Address | (string | Address)[];
   filter?: (obj: { level: string; message: any; meta: any }) => boolean;
 }
 
 export class NodemailerTransport extends Transport {
 
   private from?: string | Address;
-  private to?: string | Address | Array<string | Address>;
+  private to?: string | Address | (string | Address)[];
 
   private tags?: string;
   private filter?: (obj: { level: string; message: any; meta: any }) => boolean;
@@ -52,12 +52,6 @@ export class NodemailerTransport extends Transport {
 
   /**
    * log data
-   *
-   * @param  {String}   level
-   * @param  {String}   msg
-   * @param  {Object}   meta
-   * @param  {Function} cb
-   *
    */
   public log(info: any, next: () => void): any {
     if (this.silent) {
@@ -68,15 +62,28 @@ export class NodemailerTransport extends Transport {
       return next();
     }
 
-    if (!info.msg) {
-      info.msg = '';
+    let text: string;
+    if (typeof info.message === 'undefined') {
+      text = 'undefined';
+    } else if (typeof info.message === 'string') {
+      text = info.message;
+    } else {
+      text = util.inspect(info.message);
     }
 
-    let text = info.msg.toString();
-    const subject = '' + (this.tags || '') + `[${info.level}] ` + text.slice(0, 51);
+    const subject = (this.tags || '') + `[${info.level}] ` + text.slice(0, 51);
 
-    if (info.meta) {
-      text += '\n---\n' + util.inspect(info.meta);
+    const meta: any = {};
+    let hasMeta = false;
+    for (const key of Object.keys(info)) {
+      if (key !== 'message' && key !== 'level') {
+        meta[key] = info[key];
+        hasMeta = true;
+      }
+    }
+
+    if (hasMeta) {
+      text += '\n---\n' + util.inspect(meta);
     }
 
     this.smtpTransport.sendMail({