sm-utility 1.0.3 → 1.1.0

package/general/index.d.ts

@@ -1,3 +1,4 @@
 export declare function pipe(...fns: Array<Function>): any;
 export declare function randomSixDigitNumber(): number;
 export declare function timeout(ms: number): Promise<any>;
+export declare function mergeDeep(target: Record<string, any>, source: Record<string, any>): Record<string, any>;

package/general/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.timeout = exports.randomSixDigitNumber = exports.pipe = void 0;
+exports.mergeDeep = exports.timeout = exports.randomSixDigitNumber = exports.pipe = void 0;
 function pipe() {
     var fns = [];
     for (var _i = 0; _i < arguments.length; _i++) {
@@ -17,3 +17,26 @@ function timeout(ms) {
     return new Promise(function (resolve) { return setTimeout(resolve, ms); });
 }
 exports.timeout = timeout;
+function isObject(obj) {
+    return !!obj && obj.constructor === Object;
+}
+function mergeDeep(target, source) {
+    if (!isObject(target) || !isObject(source)) {
+        return source;
+    }
+    Object.keys(source).forEach(function (key) {
+        var targetValue = target[key];
+        var sourceValue = source[key];
+        if (Array.isArray(targetValue) && Array.isArray(sourceValue)) {
+            target[key] = targetValue.concat(sourceValue);
+        }
+        else if (isObject(targetValue) && isObject(sourceValue)) {
+            target[key] = mergeDeep(Object.assign({}, targetValue), sourceValue);
+        }
+        else {
+            target[key] = sourceValue;
+        }
+    });
+    return target;
+}
+exports.mergeDeep = mergeDeep;

package/logger/index.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="express" />
+/// <reference types="qs" />
+import winston from "winston";
+export declare const loggerMiddleware: import("express").Handler;
+export declare const logError: import("express").ErrorRequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
+export declare const logger: winston.Logger;

package/logger/index.js

@@ -0,0 +1,90 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = exports.logError = exports.loggerMiddleware = void 0;
+var process_1 = require("process");
+var winston_1 = __importDefault(require("winston"));
+var express_winston_1 = __importDefault(require("express-winston"));
+var configs;
+try {
+    configs = require(process_1.cwd() + "/logger.config");
+}
+catch (_a) {
+    throw Error('Logger configs could not be found on app root\'s directory.');
+}
+function formatReqResLog(info) {
+    var level = info.level, _a = info.meta, req = _a.req, res = _a.res, responseTime = _a.responseTime;
+    var logData = Object.assign({}, { req: req, res: res, responseTime: responseTime + "ms" });
+    return level + " - [" + req.method + "] " + req.url + ": " + JSON.stringify(logData);
+}
+function filterRequestHeaders(confidentialHeaders) {
+    if (confidentialHeaders === void 0) { confidentialHeaders = []; }
+    return function (req, propName) {
+        if (propName !== "headers")
+            return req[propName];
+        var filteredHeaders = Object.keys(req.headers)
+            .filter(function (key) { return !confidentialHeaders.includes(key); })
+            .reduce(function (acc, key) {
+            acc[key] = req.headers[key];
+            return acc;
+        }, {});
+        return filteredHeaders;
+    };
+}
+var routeFilter = function (req, res) {
+    var url = req.url;
+    var shouldRouteBeFiltered = shouldFilterRoute(url);
+    return shouldRouteBeFiltered;
+};
+function shouldFilterRoute(url) {
+    var routesToBeFiltered = configs.ignoredRoutes || [];
+    var shouldRouteBeFiltered = routesToBeFiltered.some(function (route) {
+        var splitedRouteParts = getSplitedRouteParts(route);
+        return splitedRouteParts.every(function (part) { return url.toLowerCase().indexOf(part) > -1; });
+    });
+    return shouldRouteBeFiltered;
+}
+function getSplitedRouteParts(route) {
+    var routeParts = route.split('/');
+    var filteredParts = routeParts.filter(function (part) {
+        var firstChar = part === null || part === void 0 ? void 0 : part.charAt(0);
+        return firstChar !== ":" && firstChar !== '';
+    });
+    return filteredParts;
+}
+function createLoggerMiddleware() {
+    express_winston_1.default.requestWhitelist.push("body");
+    express_winston_1.default.responseWhitelist.push("body");
+    return express_winston_1.default.logger({
+        statusLevels: true,
+        transports: [
+            new winston_1.default.transports.Console(configs.console),
+        ],
+        requestFilter: filterRequestHeaders(configs.confidentialHeaders || []),
+        ignoreRoute: routeFilter,
+        format: winston_1.default.format.combine(winston_1.default.format.colorize(), winston_1.default.format.printf(formatReqResLog))
+    });
+}
+function createErrorLoggerMiddleware() {
+    return express_winston_1.default.errorLogger({
+        transports: [
+            new winston_1.default.transports.Console(configs.console)
+        ],
+        requestFilter: filterRequestHeaders(configs.confidentialHeaders || []),
+    });
+}
+exports.loggerMiddleware = createLoggerMiddleware();
+exports.logError = createErrorLoggerMiddleware();
+exports.logger = winston_1.default.createLogger({
+    transports: [
+        new winston_1.default.transports.Console(configs.console)
+    ],
+    exitOnError: false,
+});
+exports.logger.stream = Object.assign(exports.logger.stream, {
+    write: function (message) {
+        exports.logger.info(JSON.parse(message));
+    },
+});

package/logger/types.d.ts

@@ -0,0 +1,7 @@
+import winston from "winston";
+export interface ILoggerConfigs {
+    console: winston.transports.ConsoleTransportOptions;
+    file: winston.transports.FileTransportOptions;
+    confidentialHeaders?: string[];
+    ignoredRoutes?: string[];
+}

package/logger/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "sm-utility",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "reusable utility codes for sm projects",
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {
-    "clean": "rm -rf general/ date/ string/ array/ middleware/",
+    "clean": "rm -rf general/ date/ string/ array/ logger/ request/",
     "build": "npm run clean && tsc",
     "prepare": "npm run build",
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -17,15 +17,20 @@
     "/date",
     "/string",
     "/array",
-    "/middleware"
+    "/logger",
+    "/request",
+    "/typings"
   ],
   "devDependencies": {
     "@types/express": "^4.17.11",
     "@types/node": "^14.14.40",
+    "@types/uuid": "^8.3.1",
     "typescript": "^4.2.4"
   },
   "dependencies": {
+    "axios": "^0.23.0",
     "express-winston": "^4.1.0",
+    "uuid": "^8.3.2",
     "winston": "^3.3.3"
   }
 }

package/request/index.d.ts

@@ -0,0 +1,2 @@
+import { AxiosInstance, AxiosRequestConfig } from 'axios';
+export declare function createApi(config?: AxiosRequestConfig): AxiosInstance;

package/request/index.js

@@ -0,0 +1,59 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createApi = void 0;
+var axios_1 = __importDefault(require("axios"));
+var uuid_1 = require("uuid");
+function createApi(config) {
+    var axiosApi = axios_1.default.create(config);
+    axiosApi.interceptors.request.use(function (request) {
+        var url = request.url, data = request.data, params = request.params, method = request.method;
+        request.meta = request.meta || {};
+        request.meta.requestId = uuid_1.v4();
+        request.meta.requestStartedAt = new Date().getTime();
+        logApiInfo(request.meta.requestId, 'Request', method, url, {
+            data: data,
+            params: params,
+        });
+        return request;
+    });
+    axiosApi.interceptors.response.use(function (response) {
+        var status = response.status, data = response.data, config = response.config;
+        var method = config.method, url = config.url, meta = config.meta;
+        var responseTime = getResponseTimeFromConfig(config);
+        logApiInfo(meta === null || meta === void 0 ? void 0 : meta.requestId, 'Response', method, url, {
+            status: status,
+            data: data,
+            responseTime: responseTime,
+        });
+        return response;
+    }, function (error) {
+        var config = error.config, message = error.message, response = error.response;
+        var method = config.method, url = config.url, meta = config.meta;
+        var responseTime = getResponseTimeFromConfig(config);
+        logApiInfo(meta === null || meta === void 0 ? void 0 : meta.requestId, 'Error', method, url, {
+            status: response === null || response === void 0 ? void 0 : response.status,
+            message: message,
+            data: response === null || response === void 0 ? void 0 : response.data,
+            responseTime: responseTime,
+        });
+        return error;
+    });
+    return axiosApi;
+}
+exports.createApi = createApi;
+function logApiInfo(id, title, method, url, content) {
+    var formattedLog = "(" + title + ") " + id + " - [" + (method === null || method === void 0 ? void 0 : method.toUpperCase()) + "] " + url + ": " + JSON.stringify(content);
+    console.log(formattedLog);
+}
+function getResponseTimeFromConfig(config) {
+    var _a;
+    var requestStart = (_a = config === null || config === void 0 ? void 0 : config.meta) === null || _a === void 0 ? void 0 : _a.requestStartedAt;
+    var responseTime = '-';
+    if (requestStart) {
+        responseTime = String(new Date().getTime() - requestStart);
+    }
+    return responseTime + ' ms';
+}

package/middleware/index.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="express" />
-/// <reference types="qs" />
-import winston from "winston";
-declare function createLoggerMiddleware(confidentialHeaders?: string[]): import("express").Handler;
-declare function createErrorLoggerMiddleware(confidentialHeaders?: string[]): import("express").ErrorRequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
-declare const logger: winston.Logger;
-export { logger, createLoggerMiddleware, createErrorLoggerMiddleware };

package/middleware/index.js

@@ -1,85 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createErrorLoggerMiddleware = exports.createLoggerMiddleware = exports.logger = void 0;
-var process_1 = require("process");
-var winston_1 = __importDefault(require("winston"));
-var express_winston_1 = __importDefault(require("express-winston"));
-var configs = {
-    winston: {
-        file: {
-            level: "info",
-            filename: process_1.cwd() + "/logs/access." + process.env.NODE_ENV + ".log",
-            handleExceptions: true,
-            json: true,
-            maxsize: 5242880,
-            maxFiles: 5,
-            colorize: false,
-        },
-        console: {
-            level: "debug",
-            handleExceptions: true,
-            json: true,
-            colorize: true,
-            format: winston_1.default.format.combine(winston_1.default.format.colorize(), winston_1.default.format.printf(formatReqResLog)),
-        },
-    },
-};
-function formatReqResLog(info) {
-    var level = info.level, _a = info.meta, req = _a.req, res = _a.res, responseTime = _a.responseTime;
-    return level + " - [" + req.method + "] " + req.url + ": {\"req\": " + JSON.stringify(req) + ", \"res\": " + JSON.stringify(res) + ", \"responseTime\": \"" + responseTime + "ms\"}";
-}
-function filterRequestHeaders(confidentialHeaders) {
-    if (confidentialHeaders === void 0) { confidentialHeaders = []; }
-    return function (req, propName) {
-        if (propName !== "headers")
-            return req[propName];
-        var filteredHeaders = Object.keys(req.headers)
-            .filter(function (key) { return !confidentialHeaders.includes(key); })
-            .reduce(function (acc, key) {
-            acc[key] = req.headers[key];
-            return acc;
-        }, {});
-        return filteredHeaders;
-    };
-}
-function createLoggerMiddleware(confidentialHeaders) {
-    if (confidentialHeaders === void 0) { confidentialHeaders = []; }
-    express_winston_1.default.requestWhitelist.push("body");
-    express_winston_1.default.responseWhitelist.push("body");
-    return express_winston_1.default.logger({
-        statusLevels: true,
-        transports: [
-            new winston_1.default.transports.Console(configs.winston.console),
-            new winston_1.default.transports.File(configs.winston.file),
-        ],
-        requestFilter: filterRequestHeaders(confidentialHeaders),
-    });
-}
-exports.createLoggerMiddleware = createLoggerMiddleware;
-function createErrorLoggerMiddleware(confidentialHeaders) {
-    if (confidentialHeaders === void 0) { confidentialHeaders = []; }
-    return express_winston_1.default.errorLogger({
-        transports: [
-            new winston_1.default.transports.Console(configs.winston.console),
-            new winston_1.default.transports.File(configs.winston.file),
-        ],
-        requestFilter: filterRequestHeaders(confidentialHeaders),
-    });
-}
-exports.createErrorLoggerMiddleware = createErrorLoggerMiddleware;
-var logger = winston_1.default.createLogger({
-    transports: [
-        new winston_1.default.transports.Console(configs.winston.console),
-        new winston_1.default.transports.File(configs.winston.file),
-    ],
-    exitOnError: false,
-});
-exports.logger = logger;
-logger.stream = Object.assign(logger.stream, {
-    write: function (message) {
-        logger.info(JSON.parse(message));
-    },
-});