@log4js-node/smtp 2.0.0 → 2.0.3

package/README.md

@@ -1,5 +1,7 @@
-# SMTP Appender for log4js
-[![Build Status](https://travis-ci.com/log4js-node/smtp.svg?branch=master)](https://travis-ci.com/log4js-node/smtp)
+SMTP Appender for log4js [![CodeQL](https://github.com/log4js-node/smtp/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/log4js-node/smtp/actions/workflows/codeql-analysis.yml) [![Node.js CI](https://github.com/log4js-node/smtp/actions/workflows/node.js.yml/badge.svg)](https://github.com/log4js-node/smtp/actions/workflows/node.js.yml)
+===========
+
+[![NPM](https://nodei.co/npm/@log4js-node/smtp.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/@log4js-node/smtp/)
 
 Sends log events as emails. If you use this appender, you should also call `log4js.shutdown` when your application closes so that any remaining emails can be sent. Many of the configuration options below are passed through to nodemailer, so you should read their docs to get the most out of this appender.
 
@@ -30,7 +32,7 @@ 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
 

package/lib/index.js

@@ -14,7 +14,6 @@ function getTransportOptions(config) {
   return options;
 }
 
-
 /**
  * SMTP Appender. Sends logging events using SMTP protocol.
  * It can either send an email on each event or group several
@@ -38,6 +37,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;
@@ -78,7 +80,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;
@@ -137,5 +139,4 @@ function configure(config, layouts) {
   return smtpAppender(config, layout, subjectLayout);
 }
 
-
 module.exports.configure = configure;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@log4js-node/smtp",
-  "version": "2.0.0",
+  "version": "2.0.3",
   "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": "^6.6.1"
+    "debug": "^4.3.3",
+    "nodemailer": "^6.7.2"
   },
   "devDependencies": {
-    "@log4js-node/sandboxed-module": "^2.1.1",
-    "codecov": "^3.0.0",
-    "conventional-changelog": "^1.1.15",
-    "eslint": "^4.10.0",
-    "eslint-config-airbnb-base": "^12.1.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",
+    "@log4js-node/sandboxed-module": "^2.2.1",
+    "codecov": "^3.8.3",
+    "conventional-changelog": "^3.1.25",
+    "eslint": "^8.11.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-import-resolver-node": "^0.3.6",
+    "eslint-plugin-import": "^2.25.4",
+    "husky": "^7.0.4",
+    "nyc": "^15.1.0",
+    "tap": "^16.0.0",
+    "typescript": "^4.6.2",
     "validate-commit-msg": "^2.14.0"
   },
   "browser": {

package/types/index.d.ts

@@ -1,5 +1,63 @@
 // 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)
@@ -50,4 +108,4 @@ export interface SmtpAppender {
 	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
+  }
+}