sm-utility 1.4.2 → 1.4.3

package/logger/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="express" />
 /// <reference types="qs" />
-import winston from "winston";
+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

@@ -10,17 +10,17 @@ const express_winston_1 = __importDefault(require("express-winston"));
 const ecs_winston_format_1 = __importDefault(require("@elastic/ecs-winston-format"));
 let configs;
 try {
-    configs = require(process_1.cwd() + "/logger.config");
+    configs = require(process_1.cwd() + '/logger.config');
 }
 catch {
-    throw Error('Logger configs could not be found on app root\'s directory.');
+    throw Error("Logger configs could not be found on app root's directory.");
 }
 function filterRequestHeaders(confidentialHeaders = []) {
     return (req, propName) => {
-        if (propName !== "headers")
+        if (propName !== 'headers')
             return req[propName];
         const filteredHeaders = Object.keys(req.headers)
-            .filter((key) => !confidentialHeaders.includes(key))
+            .filter(key => !confidentialHeaders.includes(key))
             .reduce((acc, key) => {
             acc[key] = req.headers[key];
             return acc;
@@ -30,25 +30,18 @@ function filterRequestHeaders(confidentialHeaders = []) {
 }
 const routeFilter = (req, res) => {
     const { url } = req;
-    const shouldRouteBeFiltered = shouldFilterRoute(url);
+    const routesToBeFiltered = configs.ignoredRoutes || [];
+    const shouldRouteBeFiltered = shouldFilterRoute(url, routesToBeFiltered);
     return shouldRouteBeFiltered;
 };
-function shouldFilterRoute(url) {
-    const routesToBeFiltered = configs.ignoredRoutes || [];
-    const shouldRouteBeFiltered = routesToBeFiltered.some((route) => {
-        const splitedRouteParts = getSplitedRouteParts(route);
-        return splitedRouteParts.every(part => url.toLowerCase().indexOf(part) > -1);
+function shouldFilterRoute(url, routesToBeFiltered) {
+    const shouldRouteBeFiltered = routesToBeFiltered.some(route => {
+        const regExp = generateRouteRegex(route);
+        const matches = new String(url).match(regExp);
+        return !!(matches === null || matches === void 0 ? void 0 : matches.length);
     });
     return shouldRouteBeFiltered;
 }
-function getSplitedRouteParts(route) {
-    const routeParts = route.split('/');
-    const filteredParts = routeParts.filter(part => {
-        const firstChar = part === null || part === void 0 ? void 0 : part.charAt(0);
-        return firstChar !== ":" && firstChar !== '';
-    });
-    return filteredParts;
-}
 function getTransports() {
     const transports = [];
     if (configs.console) {
@@ -59,15 +52,53 @@ function getTransports() {
     }
     return transports;
 }
+function isRequestInfo(info) {
+    const metadata = info.meta;
+    return (metadata === null || metadata === void 0 ? void 0 : metadata.req) && (metadata === null || metadata === void 0 ? void 0 : metadata.res) ? true : false;
+}
+function generateRouteRegex(route) {
+    const splitedRoute = route.split('/').filter(i => i !== '');
+    const regexString = splitedRoute
+        .map(i => {
+        return (i === null || i === void 0 ? void 0 : i.charAt(0)) === ':' ? '(.)+' : i;
+    })
+        .join('/');
+    const regExp = new RegExp('^/' + regexString + '$', 'g');
+    return regExp;
+}
+function filterBlacklistedBodysByRoute(info) {
+    var _a;
+    const blacklistedRoutes = configs.responseBlacklistBodyRoutes || [];
+    const request = info.meta.req;
+    const shouldBeFiltered = blacklistedRoutes.some(({ route, method }) => {
+        const regExp = generateRouteRegex(route);
+        const matches = new String(request.url).match(regExp);
+        return ((matches === null || matches === void 0 ? void 0 : matches.length) && request.method.toLowerCase() === method.toLowerCase());
+    });
+    if (shouldBeFiltered) {
+        (_a = info.meta.res) === null || _a === void 0 ? true : delete _a.body;
+    }
+    return info;
+}
+function formatBlacklistedBody() {
+    return winston_1.default.format(info => {
+        const isRequest = isRequestInfo(info);
+        if (isRequest) {
+            const filteredInfo = filterBlacklistedBodysByRoute(info);
+            return filteredInfo;
+        }
+        return info;
+    })();
+}
 function createLoggerMiddleware() {
-    express_winston_1.default.requestWhitelist.push("body", ...configs.requestWhitelist || []);
-    express_winston_1.default.responseWhitelist.push("body", ...configs.responseWhitelist || []);
+    express_winston_1.default.requestWhitelist.push('body', ...(configs.requestWhitelist || []));
+    express_winston_1.default.responseWhitelist.push('body', ...(configs.responseWhitelist || []));
     return express_winston_1.default.logger({
         statusLevels: true,
         transports: getTransports(),
         requestFilter: filterRequestHeaders(configs.confidentialHeaders || []),
         ignoreRoute: routeFilter,
-        format: ecs_winston_format_1.default({ convertReqRes: true })
+        format: winston_1.default.format.combine(formatBlacklistedBody(), ecs_winston_format_1.default({ convertReqRes: true })),
     });
 }
 function createErrorLoggerMiddleware() {

package/logger/types.d.ts

@@ -1,9 +1,52 @@
 import winston from "winston";
 export interface ILoggerConfigs {
-    console: winston.transports.ConsoleTransportOptions;
-    file: winston.transports.FileTransportOptions;
+    /**
+     * (Opcional)
+     * Configurações aplicadas aos logs que serão exibidos no console.
+     * Para mais detalhes, veja a documentação oficial do winston (https://github.com/winstonjs/winston/blob/master/docs/transports.md#console-transport).
+     * Caso não informado, a opção de logs pelo console será desativada.
+     */
+    console?: winston.transports.ConsoleTransportOptions;
+    /**
+     * (Opcional)
+     * Configurações aplicadas aos logs que serão gravadas em arquivos.
+     * Para mais detalhes, veja a documentação oficial do winston (https://github.com/winstonjs/winston/blob/master/docs/transports.md#file-transport).
+     * Caso não informado, a opção de logs em arquivos será desativada.
+     */
+    file?: winston.transports.FileTransportOptions;
+    /**
+     * (Opcional)
+     * Array de strings dos headers que serão removidos dos logs no objeto de requisição.
+     */
     confidentialHeaders?: string[];
+    /**
+     * (Opcional)
+     * Array de strings das rotas a serem removidas totalmento dos logs (tanto a requisição, quanto a resposta).
+     * Caso a rota possua algum parâmetro, é necessário informalo iniciando em :.
+     * Exemplo: [`/offers/:offerId/details`, `/offers/list`, `/users/:user_id`].
+     */
     ignoredRoutes?: string[];
+    /**
+   * (Opcional)
+   * Array de strings dos parâmetros do objeto de requisição a serem logados.
+   * Caso nenhum valor seja passado, somente o body será exibido por padrão.
+   */
     requestWhitelist?: string[];
+    /**
+     * (Opcional)
+     * Array de strings dos parâmetros do objeto de resposta a serem logados.
+     * Caso nenhum valor seja passado, somente o body será exibido por padrão.
+     */
     responseWhitelist?: string[];
+    /**
+     * (Opcional)
+     * Array de objetos contendo as rotas e métodos, referente as chamadas das quais
+     * o parâmetro body será omitido no objeto de resposta nos logs.
+     * Caso a rota possua algum parâmetro, é necessário informalo iniciando em :.
+     * Exemplo: [{ route: `offers/:offerId/details`, method: `POST` }]
+     */
+    responseBlacklistBodyRoutes?: Array<{
+        route: string;
+        method: string;
+    }>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sm-utility",
-  "version": "1.4.2",
+  "version": "1.4.3",
   "description": "reusable utility codes for sm projects",
   "main": "index.js",
   "types": "index.d.ts",

package/request/index.d.ts

@@ -1,2 +1,3 @@
-import { AxiosInstance, AxiosRequestConfig } from 'axios';
-export declare function createApi(axiosConfig?: AxiosRequestConfig): AxiosInstance;
+import { AxiosInstance } from 'axios';
+import { RequestConfig } from './types';
+export declare function createApi(axiosConfig?: RequestConfig): AxiosInstance;

package/request/types.d.ts

@@ -0,0 +1,5 @@
+import { AxiosRequestConfig } from 'axios';
+export interface RequestConfig extends AxiosRequestConfig {
+    meta?: Record<string, any>;
+    logRequests?: boolean;
+}

package/request/types.js

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