@log4js-node/smtp 1.0.0 → 2.0.1

package/README.md

@@ -17,7 +17,7 @@ npm install @log4js-node/smtp
   * `auth` - `object` (optional) - authentication details
     * `user` - `string`
     * `pass` - `string`
-* `transport` - `object` (optional, if not present will use `SMTP`) - see nodemailer docs for transport options
+* `transport` - `object` (optional, if not present will use `SMTP`) - see [`nodemailer`](https://nodemailer.com/smtp/) docs for transport options
   * `plugin` - `string` (optional, defaults to `smtp`) - the nodemailer transport plugin to use
   * `options` - `object` - configuration for the transport plugin
 * `attachment` - `object` (optional) - send logs as email attachment
@@ -30,7 +30,9 @@ npm install @log4js-node/smtp
 * `subject` - `string` (optional, defaults to message from first log event in batch) - subject for email
 * `sender` - `string` (optional) - who the logs should be sent as
 * `html` - `boolean` (optional, defaults to `false`) - send the email as HTML instead of plain text
-* `layout` - `object` (optional, defaults to basicLayout) - see [layouts](layouts.md)
+* `layout` - `object` (optional, defaults to basicLayout) - see [layouts](https://log4js-node.github.io/log4js-node/layouts.html)
+* `cc` - `string` (optional) - email addresses to send the carbon-copy logs to
+* `bcc` - `string` (optional) - email addresses to send the blind-carbon-copy logs to
 
 ## Example (default config)
 ```javascript
@@ -72,7 +74,7 @@ This configuration will send an email once every hour, with all the log events o
 log4js.configure({
   appenders: {
     email: {
-      type: '@log4js-node/smtp', smtp: { host: 'smtp.company.name', port: 8025 }, recipients: 'dev.team@company.name'
+      type: '@log4js-node/smtp', SMTP: { host: 'smtp.company.name', port: 8025 }, recipients: 'dev.team@company.name'
     }
   },
   categories: { default: { appenders: ['email'], level: 'info' } }
@@ -99,4 +101,4 @@ log4js.configure({
   }
 });
 ```
-A similar config can be used to specify a different transport plugin than `smtp`. See the nodemailer docs for more details.
+A similar config can be used to specify a different transport plugin than `smtp`. See the [`nodemailer`](https://nodemailer.com/smtp/) docs for more details.

package/lib/index.js

@@ -4,7 +4,7 @@ const mailer = require('nodemailer');
 const os = require('os');
 
 function getTransportOptions(config) {
-  let options = null;
+  let options = {};
   if (config.SMTP) {
     options = config.SMTP;
   } else if (config.transport) {
@@ -38,6 +38,9 @@ function smtpAppender(config, layout, subjectLayout) {
   const sendInterval = config.sendInterval * 1000 || 0;
   const shutdownTimeout = ('shutdownTimeout' in config ? config.shutdownTimeout : 5) * 1000;
   const transport = mailer.createTransport(getTransportOptions(config));
+  transport.on('error', (error) => {
+    console.error('log4js.smtpAppender - Error happened', error); // eslint-disable-line no-console
+  });
   const logEventBuffer = [];
 
   let unsentCount = 0;
@@ -55,7 +58,9 @@ function smtpAppender(config, layout, subjectLayout) {
       const msg = {
         to: config.recipients,
         subject: config.subject || subjectLayout(firstEvent),
-        headers: { Hostname: os.hostname() }
+        headers: { Hostname: os.hostname() },
+        cc: config.cc,
+        bcc: config.bcc,
       };
 
       if (config.attachment.enable === true) {
@@ -76,7 +81,7 @@ function smtpAppender(config, layout, subjectLayout) {
       }
       transport.sendMail(msg, (error) => {
         if (error) {
-          console.error('log4js.smtpAppender - Error happened', error); //eslint-disable-line
+          console.error('log4js.smtpAppender - Send mail error happened', error); // eslint-disable-line no-console
         }
         transport.close();
         unsentCount -= count;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@log4js-node/smtp",
-  "version": "1.0.0",
+  "version": "2.0.1",
   "description": "SMTP Appender for log4js-node",
   "homepage": "https://log4js-node.github.io/log4js-node/",
   "files": [
@@ -33,6 +33,7 @@
     "commitmsg": "validate-commit-msg",
     "pretest": "eslint 'lib/**/*.js' 'test/**/*.js'",
     "test": "tap 'test/tap/**/*.js' --100",
+    "typings": "tsc -p types/tsconfig.json",
     "codecov": "tap 'test/tap/**/*.js' --cov --coverage-report=lcov && codecov"
   },
   "directories": {
@@ -40,20 +41,21 @@
     "lib": "lib"
   },
   "dependencies": {
-    "debug": "^3.1.0",
-    "nodemailer": "^4.6.4"
+    "debug": "^4.3.3",
+    "nodemailer": "^6.7.2"
   },
   "devDependencies": {
-    "@log4js-node/sandboxed-module": "^2.1.1",
+    "@log4js-node/sandboxed-module": "^2.2.1",
     "codecov": "^3.0.0",
-    "conventional-changelog": "^1.1.15",
-    "eslint": "^4.10.0",
-    "eslint-config-airbnb-base": "^12.1.0",
+    "conventional-changelog": "^3.1.25",
+    "eslint": "^8.7.0",
+    "eslint-config-airbnb-base": "^13.2.0",
     "eslint-import-resolver-node": "^0.3.1",
     "eslint-plugin-import": "^2.8.0",
-    "husky": "^0.14.3",
-    "nyc": "^11.5.0",
-    "tap": "^12.0.1",
+    "husky": "^7.0.4",
+    "nyc": "^15.1.0",
+    "tap": "^15.1.6",
+    "typescript": "^4.5.5",
     "validate-commit-msg": "^2.14.0"
   },
   "browser": {

package/types/index.d.ts

@@ -1,5 +1,64 @@
 // Type definitions for log4js SMTP appender
 
+export interface BaseLayout {
+  type: 'basic';
+}
+
+export interface ColoredLayout {
+  type: 'colored' | 'coloured';
+}
+
+export interface MessagePassThroughLayout {
+  type: 'messagePassThrough';
+}
+
+export interface DummyLayout {
+  type: 'dummy';
+}
+
+
+export interface Level {
+  isEqualTo(other: string): boolean;
+  isEqualTo(otherLevel: Level): boolean;
+  isLessThanOrEqualTo(other: string): boolean;
+  isLessThanOrEqualTo(otherLevel: Level): boolean;
+  isGreaterThanOrEqualTo(other: string): boolean;
+  isGreaterThanOrEqualTo(otherLevel: Level): boolean;
+  colour: string;
+  level: number;
+  levelStr: string;
+}
+
+export interface LoggingEvent {
+  categoryName: string;  // name of category
+  level: Level;  // level of message
+  data: any[];  // objects to log
+  startTime: Date;
+  pid: number;
+  context: any;
+  cluster?: {
+    workerId: number;
+    worker: number;
+  };
+}
+
+export type Token = ((logEvent: LoggingEvent) => string) | string;
+
+export interface PatternLayout {
+  type: 'pattern';
+  // specifier for the output format, using placeholders as described below
+  pattern: string;
+  // user-defined tokens to be used in the pattern
+  tokens?: { [name: string]: Token };
+}
+
+export interface CustomLayout {
+  [key: string]: any;
+  type: string;
+}
+
+export type Layout = BaseLayout | ColoredLayout | MessagePassThroughLayout | DummyLayout | PatternLayout | CustomLayout;
+
 export interface SmtpAppender {
 	type: '@log4js-node/smtp';
 	// (if not present will use transport field)
@@ -44,6 +103,10 @@ export interface SmtpAppender {
 	html?: boolean;
 	// (defaults to basicLayout)
 	layout?: Layout;
+	// email addresses to send the carbon-copy logs to
+	cc?: string;
+	// email addresses to send the blind-carbon-copy logs to
+	bcc?: string;
 }
 
-export type Appender = Appender | SmtpAppender;
+export type Appender = SmtpAppender;

package/types/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "strict": true,
+    "noUnusedParameters": true,
+    "noUnusedLocals": false,
+    "noEmit": true
+  }
+}