express-ext 0.1.13 → 0.1.14

package/lib/LogController.js

@@ -1,9 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.map = {
+  TRACE: -2,
+  DEBUG: -1,
+  INFO: 0,
+  WARN: 1,
+  ERROR: 2,
+  PANIC: 3,
+  FATAL: 4
+};
 var LogController = (function () {
   function LogController(logger, mp) {
     this.logger = logger;
-    this.map = mp;
+    this.map = (mp ? mp : exports.map);
     this.config = this.config.bind(this);
   }
   LogController.prototype.config = function (req, res) {
@@ -11,14 +20,14 @@ var LogController = (function () {
     if (!obj || obj === '') {
       return res.status(400).end('The request body cannot be empty');
     }
-    if (!this.logger || !this.map) {
+    if (!this.logger) {
       return res.status(503).end('Logger is not available');
     }
-    if (!this.map) {
-      return res.status(503).end('Map is not available');
-    }
     var changed = false;
-    if (obj.level && typeof obj.level === 'string' && obj.level.length > 0) {
+    if (typeof obj.level === 'string' && obj.level.length > 0) {
+      if (!this.map) {
+        return res.status(503).end('Map is not available');
+      }
       var lv = this.map[obj.level.toUpperCase()];
       if (lv !== undefined) {
         this.logger.level = lv;
@@ -26,19 +35,35 @@ var LogController = (function () {
       }
     }
     if (obj.map) {
-      if (obj.map.level && typeof obj.map.level === 'string' && obj.map.level.length > 0) {
+      if (typeof obj.map.level === 'string' && obj.map.level.length > 0) {
         this.logger.map.level = obj.map.level;
         changed = true;
       }
-      if (obj.map.time && typeof obj.map.time === 'string' && obj.map.time.length > 0) {
+      if (typeof obj.map.time === 'string' && obj.map.time.length > 0) {
         this.logger.map.time = obj.map.time;
         changed = true;
       }
-      if (obj.map.msg && typeof obj.map.msg === 'string' && obj.map.msg.length > 0) {
+      if (typeof obj.map.msg === 'string' && obj.map.msg.length > 0) {
         this.logger.map.msg = obj.map.msg;
         changed = true;
       }
     }
+    if (obj.constants !== undefined && typeof obj.constants === 'object') {
+      this.logger.constants = obj.constants;
+      changed = true;
+    }
+    if (obj.name) {
+      if (typeof obj.name.trace === 'string'
+        && typeof obj.name.debug === 'string'
+        && typeof obj.name.info === 'string'
+        && typeof obj.name.warn === 'string'
+        && typeof obj.name.error === 'string'
+        && typeof obj.name.panic === 'string'
+        && typeof obj.name.fatal === 'string') {
+        this.logger.name = obj.name;
+        changed = true;
+      }
+    }
     if (changed) {
       return res.status(200).end('true');
     }

package/lib/log.js

@@ -37,28 +37,28 @@ function removeUrlParams(url) {
   return startParams !== -1 ? url.substring(0, startParams) : url;
 }
 exports.removeUrlParams = removeUrlParams;
-var Logger = (function () {
-  function Logger(write, conf, build) {
+var MiddlewareLogger = (function () {
+  function MiddlewareLogger(write, conf, build) {
     this.write = write;
     this.build = build;
     this.log = this.log.bind(this);
-    this.c = createConfig(conf);
+    this.conf = createConfig(conf);
   }
-  Logger.prototype.log = function (req, res, next) {
+  MiddlewareLogger.prototype.log = function (req, res, next) {
     var _this = this;
-    if (this.c.log && !skip(this.c.skips, req.originalUrl)) {
+    if (this.conf.log && !skip(this.conf.skips, req.originalUrl)) {
       var start_1 = process.hrtime();
       var m = req.method;
-      var x = this.c.request;
+      var x_1 = this.conf.request;
       var r_1 = false;
       if (m !== 'GET' && m !== 'DELETE') {
         r_1 = true;
       }
       var msg_1 = m + " " + req.originalUrl;
-      if (this.c.separate && r_1) {
-        if (this.c.request.length > 0) {
+      if (this.conf.separate && r_1) {
+        if (this.conf.request.length > 0) {
           var op = {};
-          op[x] = JSON.stringify(req.body);
+          op[x_1] = JSON.stringify(req.body);
           if (this.build) {
             var op2 = this.build(req, op);
             this.write(msg_1, op2);
@@ -73,28 +73,28 @@ var Logger = (function () {
       res.on('finish', function () {
         var duration = getDurationInMilliseconds(start_1);
         var op = {};
-        op[_this.c.duration] = duration;
-        if (r_1 && !_this.c.separate && _this.c.request.length > 0) {
-          op[_this.c.request] = JSON.stringify(req.body);
+        if (r_1 && !_this.conf.separate && _this.conf.request.length > 0) {
+          op[x_1] = JSON.stringify(req.body);
         }
-        if (_this.c.response.length > 0) {
+        if (_this.conf.response.length > 0) {
           var rsBody = Buffer.concat(chunks_1).toString();
-          op[_this.c.response] = rsBody;
+          op[_this.conf.response] = rsBody;
         }
-        if (_this.c.status.length > 0) {
-          op[_this.c.status] = res.statusCode;
+        if (_this.conf.status.length > 0) {
+          op[_this.conf.status] = res.statusCode;
         }
-        if (_this.c.size.length > 0) {
+        if (_this.conf.size.length > 0) {
           if ('_contentLength' in res) {
-            op[_this.c.size] = res['_contentLength'];
+            op[_this.conf.size] = res['_contentLength'];
           }
           else if (res.hasHeader('content-length')) {
             var l = res.getHeader('content-length');
             if (typeof l === 'number' || typeof l === 'string') {
-              op[_this.c.size] = l;
+              op[_this.conf.size] = l;
             }
           }
         }
+        op[_this.conf.duration] = duration;
         if (_this.build) {
           var op2 = _this.build(req, op);
           _this.write(msg_1, op2);
@@ -109,9 +109,9 @@ var Logger = (function () {
       next();
     }
   };
-  return Logger;
+  return MiddlewareLogger;
 }());
-exports.Logger = Logger;
+exports.MiddlewareLogger = MiddlewareLogger;
 var mapResponseBody = function (res, chunks) {
   var defaultWrite = res.write.bind(res);
   var defaultEnd = res.end.bind(res);
@@ -141,3 +141,71 @@ var getDurationInMilliseconds = function (start) {
   var diff = process.hrtime(start);
   return (diff[0] * NS_PER_SEC + diff[1]) / NS_TO_MS;
 };
+var MiddlewareController = (function () {
+  function MiddlewareController(logger) {
+    this.logger = logger;
+    this.config = this.config.bind(this);
+  }
+  MiddlewareController.prototype.config = function (req, res) {
+    var obj = req.body;
+    if (!obj || obj === '') {
+      return res.status(400).end('The request body cannot be empty');
+    }
+    if (!this.logger) {
+      return res.status(503).end('Logger is not available');
+    }
+    var changed = false;
+    if (obj.log !== undefined) {
+      this.logger.conf.log = obj.log;
+      changed = true;
+    }
+    if (obj.separate !== undefined) {
+      this.logger.conf.separate = obj.separate;
+      changed = true;
+    }
+    if (Array.isArray(obj.skips)) {
+      if (isValidSkips(obj.skips)) {
+        this.logger.conf.skips = obj.skips;
+        changed = true;
+      }
+    }
+    if (typeof obj.duration === 'string' && obj.duration.length > 0) {
+      this.logger.conf.duration = obj.duration;
+      changed = true;
+    }
+    if (typeof obj.request === 'string') {
+      this.logger.conf.request = obj.request;
+      changed = true;
+    }
+    if (typeof obj.response === 'string') {
+      this.logger.conf.response = obj.response;
+      changed = true;
+    }
+    if (typeof obj.status === 'string') {
+      this.logger.conf.status = obj.status;
+      changed = true;
+    }
+    if (typeof obj.size === 'string') {
+      this.logger.conf.size = obj.size;
+      changed = true;
+    }
+    if (changed) {
+      return res.status(200).end('true');
+    }
+    else {
+      return res.status(204).end('false');
+    }
+  };
+  return MiddlewareController;
+}());
+exports.MiddlewareController = MiddlewareController;
+function isValidSkips(s) {
+  for (var _i = 0, s_1 = s; _i < s_1.length; _i++) {
+    var x = s_1[_i];
+    if (!(typeof x === 'string')) {
+      return false;
+    }
+  }
+  return true;
+}
+exports.isValidSkips = isValidSkips;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-ext",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "express-ext",
   "main": "./lib/index.js",
   "types": "./src/index.ts",

package/src/LogController.ts

@@ -1,4 +1,5 @@
-import {Request, Response} from 'express';
+import { Request, Response } from 'express';
+import { SimpleMap } from './log';
 
 export interface NumberMap {
   [key: string]: number;
@@ -6,6 +7,8 @@ export interface NumberMap {
 export interface LogConf {
   level?: string;
   map?: LogMapConfig;
+  constants?: SimpleMap;
+  name?: Name;
 }
 export interface LogMapConfig {
   time?: string;
@@ -17,15 +20,49 @@ export interface LogMap {
   level: string;
   msg: string;
 }
-export interface LoggerConf {
+export interface Name {
+  trace: string;
+  debug: string;
+  info: string;
+  warn: string;
+  error: string;
+  panic: string;
+  fatal: string;
+}
+export interface Logger {
+  name: Name;
   level: number;
   map: LogMap;
+  constants?: SimpleMap;
+  trace(msg: string, m?: SimpleMap, ctx?: any): void;
+  debug(msg: string, m?: SimpleMap, ctx?: any): void;
+  info(msg: string, m?: SimpleMap, ctx?: any): void;
+  warn(msg: string, m?: SimpleMap, ctx?: any): void;
+  error(msg: string, m?: SimpleMap, ctx?: any): void;
+  panic(msg: string, m?: SimpleMap, ctx?: any): void;
+  fatal(msg: string, m?: SimpleMap, ctx?: any): void;
+  isLevelEnabled(level: number): boolean;
+  isTraceEnabled(): boolean;
+  isDebugEnabled(): boolean;
+  isInfoEnabled(): boolean;
+  isWarnEnabled(): boolean;
+  isErrorEnabled(): boolean;
+  isPanicEnabled(): boolean;
+  isFatalEnabled(): boolean;
 }
-
+export const map: NumberMap = {
+  TRACE: -2,
+  DEBUG: -1,
+  INFO: 0,
+  WARN: 1,
+  ERROR: 2,
+  PANIC: 3,
+  FATAL: 4
+};
 export class LogController {
-  map?: NumberMap;
-  constructor(public logger: LoggerConf, mp?: NumberMap) {
-    this.map = mp;
+  map: NumberMap;
+  constructor(public logger: Logger, mp?: NumberMap) {
+    this.map = (mp ? mp : map);
     this.config = this.config.bind(this);
   }
   config(req: Request, res: Response) {
@@ -33,14 +70,14 @@ export class LogController {
     if (!obj || obj === '') {
       return res.status(400).end('The request body cannot be empty');
     }
-    if (!this.logger || !this.map) {
+    if (!this.logger) {
       return res.status(503).end('Logger is not available');
     }
-    if (!this.map) {
-      return res.status(503).end('Map is not available');
-    }
     let changed = false;
-    if (obj.level && typeof obj.level === 'string' && obj.level.length > 0) {
+    if (typeof obj.level === 'string' && obj.level.length > 0) {
+      if (!this.map) {
+        return res.status(503).end('Map is not available');
+      }
       const lv = this.map[obj.level.toUpperCase()];
       if (lv !== undefined) {
         this.logger.level = lv;
@@ -48,19 +85,35 @@ export class LogController {
       }
     }
     if (obj.map) {
-      if (obj.map.level && typeof obj.map.level === 'string' && obj.map.level.length > 0) {
+      if (typeof obj.map.level === 'string' && obj.map.level.length > 0) {
         this.logger.map.level = obj.map.level;
         changed = true;
       }
-      if (obj.map.time && typeof obj.map.time === 'string' && obj.map.time.length > 0) {
+      if (typeof obj.map.time === 'string' && obj.map.time.length > 0) {
         this.logger.map.time = obj.map.time;
         changed = true;
       }
-      if (obj.map.msg && typeof obj.map.msg === 'string' && obj.map.msg.length > 0) {
+      if (typeof obj.map.msg === 'string' && obj.map.msg.length > 0) {
         this.logger.map.msg = obj.map.msg;
         changed = true;
       }
     }
+    if (obj.constants !== undefined && typeof obj.constants === 'object') {
+      this.logger.constants = obj.constants;
+      changed = true;
+    }
+    if (obj.name) {
+      if (typeof obj.name.trace === 'string'
+        && typeof obj.name.debug === 'string'
+        && typeof obj.name.info === 'string'
+        && typeof obj.name.warn === 'string'
+        && typeof obj.name.error === 'string'
+        && typeof obj.name.panic === 'string'
+        && typeof obj.name.fatal === 'string') {
+        this.logger.name = obj.name;
+        changed = true;
+      }
+    }
     if (changed) {
       return res.status(200).end('true');
     } else {

package/src/log.ts

@@ -23,7 +23,7 @@ export interface MiddleLog {
   status: string;
   size: string;
 }
-interface SimpleMap {
+export interface SimpleMap {
   [key: string]: string|number|boolean|Date;
 }
 export function createConfig(c?: LogConfig): MiddleLog {
@@ -58,24 +58,27 @@ export function removeUrlParams(url: string): string {
   const startParams = url.indexOf('?');
   return startParams !== -1 ? url.substring(0, startParams) : url;
 }
-export class Logger {
+export interface Middleware {
+  conf: MiddleLog;
+}
+export class MiddlewareLogger {
   constructor(public write: (msg: string, m?: SimpleMap) => void, conf?: LogConfig, public build?: (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, m: SimpleMap) => SimpleMap) {
     this.log = this.log.bind(this);
-    this.c = createConfig(conf);
+    this.conf = createConfig(conf);
   }
-  c: MiddleLog;
+  conf: MiddleLog;
   log(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>, number>, next: NextFunction) {
-    if (this.c.log && !skip(this.c.skips, req.originalUrl)) {
+    if (this.conf.log && !skip(this.conf.skips, req.originalUrl)) {
       const start = process.hrtime();
       const m = req.method;
-      const x = this.c.request;
+      const x = this.conf.request;
       let r = false;
       if (m !== 'GET' && m !== 'DELETE') {
         r = true;
       }
       const msg = `${m} ${req.originalUrl}`;
-      if (this.c.separate && r) {
-        if (this.c.request.length > 0) {
+      if (this.conf.separate && r) {
+        if (this.conf.request.length > 0) {
           const op: SimpleMap = {};
           op[x] = JSON.stringify(req.body);
           if (this.build) {
@@ -91,27 +94,27 @@ export class Logger {
       res.on('finish', () => {
           const duration = getDurationInMilliseconds(start);
           const op: SimpleMap = {};
-          op[this.c.duration] = duration;
-          if (r && !this.c.separate && this.c.request.length > 0) {
-            op[this.c.request] = JSON.stringify(req.body);
+          if (r && !this.conf.separate && this.conf.request.length > 0) {
+            op[x] = JSON.stringify(req.body);
           }
-          if (this.c.response.length > 0) {
+          if (this.conf.response.length > 0) {
             const rsBody = Buffer.concat(chunks).toString();
-            op[this.c.response] = rsBody;
+            op[this.conf.response] = rsBody;
           }
-          if (this.c.status.length > 0) {
-            op[this.c.status] = res.statusCode;
+          if (this.conf.status.length > 0) {
+            op[this.conf.status] = res.statusCode;
           }
-          if (this.c.size.length > 0) {
+          if (this.conf.size.length > 0) {
             if ('_contentLength' in res) {
-              op[this.c.size] = (res as any)['_contentLength'];
+              op[this.conf.size] = (res as any)['_contentLength'];
             } else if (res.hasHeader('content-length')) {
               const l = res.getHeader('content-length');
               if (typeof l === 'number' || typeof l === 'string') {
-                op[this.c.size] = l;
+                op[this.conf.size] = l;
               }
             }
           }
+          op[this.conf.duration] = duration;
           if (this.build) {
             const op2 = this.build(req, op);
             this.write(msg, op2);
@@ -148,3 +151,66 @@ const getDurationInMilliseconds = (start: [number, number] | undefined) => {
   const diff = process.hrtime(start);
   return (diff[0] * NS_PER_SEC + diff[1]) / NS_TO_MS;
 };
+
+export class MiddlewareController {
+  constructor(public logger: Middleware) {
+    this.config = this.config.bind(this);
+  }
+  config(req: Request, res: Response) {
+    const obj: MiddleLog = req.body;
+    if (!obj || (obj as any) === '') {
+      return res.status(400).end('The request body cannot be empty');
+    }
+    if (!this.logger) {
+      return res.status(503).end('Logger is not available');
+    }
+    let changed = false;
+    if (obj.log !== undefined) {
+      this.logger.conf.log = obj.log;
+      changed = true;
+    }
+    if (obj.separate !== undefined) {
+      this.logger.conf.separate = obj.separate;
+      changed = true;
+    }
+    if (Array.isArray(obj.skips)) {
+      if (isValidSkips(obj.skips)) {
+        this.logger.conf.skips = obj.skips;
+        changed = true;
+      }
+    }
+    if (typeof obj.duration === 'string' && obj.duration.length > 0) {
+      this.logger.conf.duration = obj.duration;
+      changed = true;
+    }
+    if (typeof obj.request === 'string') {
+      this.logger.conf.request = obj.request;
+      changed = true;
+    }
+    if (typeof obj.response === 'string') {
+      this.logger.conf.response = obj.response;
+      changed = true;
+    }
+    if (typeof obj.status === 'string') {
+      this.logger.conf.status = obj.status;
+      changed = true;
+    }
+    if (typeof obj.size === 'string') {
+      this.logger.conf.size = obj.size;
+      changed = true;
+    }
+    if (changed) {
+      return res.status(200).end('true');
+    } else {
+      return res.status(204).end('false');
+    }
+  }
+}
+export function isValidSkips(s: string[]): boolean {
+  for (const x of s) {
+    if (!(typeof x === 'string')) {
+      return false;
+    }
+  }
+  return true;
+}