micronodelib 1.0.0 → 1.0.3

package/README.md

@@ -0,0 +1,41 @@
+# Micronodelib
+
+Common core for NodeJs project.
+
+## Features
+
+- Request context injected
+- Http request log
+- Standard logging format
+
+## Install
+
+```shell
+npm install micronodelib
+
+# Or
+
+yarn add micronodelib
+```
+
+## Usage
+
+```shell
+import express, {Application} from "express";
+import {Logger, httpContextMiddleware, requestLogMiddleware} from "micronodelib";
+const app: Application = express();
+
+# Enable request context
+app.use(httpContextMiddleware);
+
+# Enable http request log
+app.use(requestLogMiddleware({
+  # Ignore request log for specific routes
+  ignoreRoutes: ["/actuator/health"]
+}));
+
+app.listen(3000, () => {
+  # Using standard log level: debug, info, warn, error
+  Logger.info('App started');
+})
+```

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { httpContextMiddleware } from "./context/http-context";
+export { requestLogMiddleware } from "./logging/middleware";
+export { Logger } from "./logging/logger";

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = exports.requestLogMiddleware = exports.httpContextMiddleware = void 0;
+var http_context_1 = require("./context/http-context");
+Object.defineProperty(exports, "httpContextMiddleware", { enumerable: true, get: function () { return http_context_1.httpContextMiddleware; } });
+var middleware_1 = require("./logging/middleware");
+Object.defineProperty(exports, "requestLogMiddleware", { enumerable: true, get: function () { return middleware_1.requestLogMiddleware; } });
+var logger_1 = require("./logging/logger");
+Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return logger_1.Logger; } });

package/dist/logging/logger.js

@@ -42,7 +42,7 @@ const winstonLogger = winston_1.default.createLogger({
             request_id: (0, express_http_context_1.get)('reqId')
         };
         info.stacktrace = info.stack;
-        info.message = "";
+        info.message = null;
         delete info.timestamp;
         delete info.stack;
         return info;

package/dist/logging/middleware.d.ts

@@ -2,4 +2,4 @@ import { Handler } from "express";
 export interface RequestLogOptions {
     ignoreRoutes: string[];
 }
-export declare const requestLogMiddleware: (opt: RequestLogOptions) => Handler;
+export declare const requestLogMiddleware: (opt?: RequestLogOptions | undefined) => Handler;

package/dist/logging/middleware.js

@@ -24,18 +24,20 @@ const requestLogMiddleware = function (opt) {
                 request_method: req.method,
                 query: new URLSearchParams(req.query).toString(),
                 url: req.url,
+                device_id: req.headers['device-id'],
+                device_session_id: req.headers['device-session-id'],
                 request_id: req.headers['x-request-id'],
                 client_ip: req.headers['x-forwarded-for'] || (req.connection ? req.connection.remoteAddress : null),
                 user_agent: req.headers['user-agent']
             };
-            info.message = "";
+            info.message = null;
             delete info.timestamp;
             delete info.meta;
             return info;
         }),
         transports: configuration_1.transports,
         ignoreRoute: function (req, res) {
-            return opt.ignoreRoutes.length > 0 && opt.ignoreRoutes.indexOf(req.url) >= 0;
+            return opt !== undefined && opt.ignoreRoutes.length > 0 && opt.ignoreRoutes.indexOf(req.url) >= 0;
         }
     });
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "micronodelib",
-  "version": "1.0.0",
-  "description": "Common package for NodeJs application",
+  "version": "1.0.3",
+  "description": "Common core for NodeJs project",
   "author": "Thang Bui",
   "license": "MIT",
   "main": "dist/index.js",