micronodelib 1.0.0

package/dist/context/http-context.d.ts

@@ -0,0 +1,2 @@
+import { NextFunction, Request, Response } from "express";
+export declare const httpContextMiddleware: ((req: Request, res: Response, next: NextFunction) => void)[];

package/dist/context/http-context.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.httpContextMiddleware = void 0;
+const express_http_context_1 = require("express-http-context");
+const uuid_1 = require("uuid");
+const requestIdMiddleware = (req, res, next) => {
+    let requestId = req.headers['x-request-id'];
+    if (!requestId) {
+        requestId = (0, uuid_1.v4)();
+    }
+    req.headers['x-request-id'] = requestId;
+    (0, express_http_context_1.set)("reqId", requestId);
+    next();
+};
+exports.httpContextMiddleware = [
+    express_http_context_1.middleware,
+    requestIdMiddleware,
+];

package/dist/logging/configuration.d.ts

@@ -0,0 +1,4 @@
+import winston from 'winston';
+import { Format, TransformFunction } from "logform";
+export declare const formatter: (transform: TransformFunction) => Format;
+export declare const transports: winston.transports.ConsoleTransportInstance[];

package/dist/logging/configuration.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transports = exports.formatter = void 0;
+const winston_1 = __importDefault(require("winston"));
+const formatter = function (transform) {
+    return winston_1.default.format.combine(winston_1.default.format.errors({ stack: true }), winston_1.default.format.timestamp(), winston_1.default.format.json(), winston_1.default.format(transform)());
+};
+exports.formatter = formatter;
+exports.transports = [
+    new winston_1.default.transports.Console({ format: winston_1.default.format.json() }),
+];

package/dist/logging/logger.d.ts

@@ -0,0 +1,7 @@
+export declare const Logger: {
+    log: (level: string, message: any, ...args: any[]) => void;
+    error: (message: any, ...args: any[]) => void;
+    warn: (message: any, ...args: any[]) => void;
+    info: (message: any, ...args: any[]) => void;
+    debug: (message: any, ...args: any[]) => void;
+};

package/dist/logging/logger.js

@@ -0,0 +1,84 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = void 0;
+const winston_1 = __importDefault(require("winston"));
+const configuration_1 = require("./configuration");
+const express_http_context_1 = require("express-http-context");
+const util = __importStar(require("util"));
+// Create the logger instance that has to be exported
+// and used to log messages.
+const winstonLogger = winston_1.default.createLogger({
+    format: (0, configuration_1.formatter)(info => {
+        info.level = info.level.toUpperCase();
+        info.msg = info.message;
+        info.ts = Date.parse(info.timestamp) / 1000;
+        info.request_meta = {
+            request_id: (0, express_http_context_1.get)('reqId')
+        };
+        info.stacktrace = info.stack;
+        info.message = "";
+        delete info.timestamp;
+        delete info.stack;
+        return info;
+    }),
+    transports: configuration_1.transports,
+});
+exports.Logger = {
+    log: function (level, message, ...args) {
+        winstonLogger.log(level, util.format(message, ...args));
+    },
+    error: function (message, ...args) {
+        let errMsg = message;
+        if (typeof message == "string" && args) {
+            let err = null;
+            for (let i = 0; i < args.length; i++) {
+                if (args[i] instanceof Error) {
+                    if (err == null) {
+                        err = args[i];
+                    }
+                    args[i] = args[i].message;
+                }
+            }
+            errMsg = new Error(util.format(message, ...args));
+            if (err != null) {
+                errMsg.stack = err.stack;
+            }
+        }
+        winstonLogger.error(errMsg);
+    },
+    warn: function (message, ...args) {
+        winstonLogger.warn(util.format(message, ...args));
+    },
+    info: function (message, ...args) {
+        winstonLogger.info(util.format(message, ...args));
+    },
+    debug: function (message, ...args) {
+        winstonLogger.debug(util.format(message, ...args));
+    }
+};

package/dist/logging/middleware.d.ts

@@ -0,0 +1,5 @@
+import { Handler } from "express";
+export interface RequestLogOptions {
+    ignoreRoutes: string[];
+}
+export declare const requestLogMiddleware: (opt: RequestLogOptions) => Handler;

package/dist/logging/middleware.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestLogMiddleware = void 0;
+const express_winston_1 = __importDefault(require("express-winston"));
+const configuration_1 = require("./configuration");
+const url_1 = __importDefault(require("url"));
+// Place this middleware before the router.
+const requestLogMiddleware = function (opt) {
+    return express_winston_1.default.logger({
+        msg: 'finish router',
+        format: (0, configuration_1.formatter)(info => {
+            const req = info.meta.req;
+            info.level = info.level.toUpperCase();
+            info.msg = info.message;
+            info.ts = Date.parse(info.timestamp) / 1000;
+            info.request_meta = {
+                status: info.meta.res.statusCode,
+                execution_time: info.meta.responseTime,
+                request_pattern: url_1.default.parse(req.url).pathname,
+                request_path: url_1.default.parse(req.url).pathname,
+                request_method: req.method,
+                query: new URLSearchParams(req.query).toString(),
+                url: req.url,
+                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 = "";
+            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;
+        }
+    });
+};
+exports.requestLogMiddleware = requestLogMiddleware;

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "micronodelib",
+  "version": "1.0.0",
+  "description": "Common package for NodeJs application",
+  "author": "Thang Bui",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "dependencies": {
+    "express-http-context": "^1.2.4",
+    "express-winston": "^4.2.0",
+    "uuid": "^8.3.2"
+  },
+  "devDependencies": {
+    "@types/uuid": "^8.3.4",
+    "typescript": "^4.6.4"
+  }
+}