sm-utility 2.4.21 → 2.4.23

package/logger/config/index.d.ts

@@ -0,0 +1,3 @@
+import { ILoggerConfigs } from "../types";
+declare let configs: ILoggerConfigs;
+export { configs };

package/logger/config/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configs = void 0;
+const process_1 = require("process");
+let configs;
+exports.configs = configs;
+try {
+    exports.configs = configs = require((0, process_1.cwd)() + "/logger.config");
+}
+catch {
+    throw Error("Logger configs could not be found on app root's directory.");
+}

package/logger/formatters/blacklist.d.ts

@@ -0,0 +1,2 @@
+import winston from "winston";
+export declare function formatBlacklistedBody(): winston.Logform.Format;

package/logger/formatters/blacklist.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatBlacklistedBody = void 0;
+const winston_1 = __importDefault(require("winston"));
+const request_1 = require("../utils/request");
+const route_1 = require("../utils/route");
+const config_1 = require("../config");
+function filterBlacklistedBodysByRoute(info) {
+    var _a, _b;
+    const blacklistedResponseRoutes = config_1.configs.responseBlacklistBodyRoutes || [];
+    const blacklistedRequestRoutes = config_1.configs.requestBlacklistBodyRoutes || [];
+    const request = info.meta.req;
+    const shouldResponseBeFiltered = (0, route_1.shouldRouteBeFiltered)(request, blacklistedResponseRoutes);
+    const shouldRequestBeFiltered = (0, route_1.shouldRouteBeFiltered)(request, blacklistedRequestRoutes);
+    if (shouldResponseBeFiltered) {
+        (_a = info.meta.res) === null || _a === void 0 ? true : delete _a.body;
+    }
+    if (shouldRequestBeFiltered) {
+        (_b = info.meta.req) === null || _b === void 0 ? true : delete _b.body;
+    }
+    return info;
+}
+function formatBlacklistedBody() {
+    return winston_1.default.format((info) => {
+        const isRequest = (0, request_1.isRequestInfo)(info);
+        if (isRequest) {
+            const filteredInfo = filterBlacklistedBodysByRoute(info);
+            return filteredInfo;
+        }
+        return info;
+    })();
+}
+exports.formatBlacklistedBody = formatBlacklistedBody;

package/logger/formatters/error.d.ts

@@ -0,0 +1,2 @@
+import winston from "winston";
+export declare const errorFormatter: winston.Logform.Format;

package/logger/formatters/error.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.errorFormatter = void 0;
+const winston_1 = __importDefault(require("winston"));
+exports.errorFormatter = winston_1.default.format((info) => {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
+    if (info.rejection) {
+        const error = info.error;
+        if (error === null || error === void 0 ? void 0 : error.isAxiosError) {
+            delete info.rejection;
+            info.error = {
+                message: error.message,
+                code: error.code,
+                status: (_a = error.response) === null || _a === void 0 ? void 0 : _a.status,
+                statusText: (_b = error.response) === null || _b === void 0 ? void 0 : _b.statusText,
+                url: (_c = error.config) === null || _c === void 0 ? void 0 : _c.url,
+                method: (_d = error.config) === null || _d === void 0 ? void 0 : _d.method,
+                baseURL: (_e = error.config) === null || _e === void 0 ? void 0 : _e.baseURL,
+                timeout: (_f = error.config) === null || _f === void 0 ? void 0 : _f.timeout,
+                responseData: (_g = error.response) === null || _g === void 0 ? void 0 : _g.data,
+                requestId: (_j = (_h = error.config) === null || _h === void 0 ? void 0 : _h.headers) === null || _j === void 0 ? void 0 : _j["x-request-id"],
+            };
+        }
+        return info;
+    }
+    const error = info.err || info.exception || info.error;
+    if (error === null || error === void 0 ? void 0 : error.isAxiosError) {
+        info.err = {
+            message: error.message,
+            code: error.code,
+            status: (_k = error.response) === null || _k === void 0 ? void 0 : _k.status,
+            statusText: (_l = error.response) === null || _l === void 0 ? void 0 : _l.statusText,
+            url: (_m = error.config) === null || _m === void 0 ? void 0 : _m.url,
+            method: (_o = error.config) === null || _o === void 0 ? void 0 : _o.method,
+            baseURL: (_p = error.config) === null || _p === void 0 ? void 0 : _p.baseURL,
+            timeout: (_q = error.config) === null || _q === void 0 ? void 0 : _q.timeout,
+            responseData: (_r = error.response) === null || _r === void 0 ? void 0 : _r.data,
+            requestId: (_t = (_s = error.config) === null || _s === void 0 ? void 0 : _s.headers) === null || _t === void 0 ? void 0 : _t["x-request-id"],
+        };
+    }
+    return info;
+})();

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

@@ -4,127 +4,52 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logger = exports.logError = exports.loggerMiddleware = void 0;
-const process_1 = require("process");
 const winston_1 = __importDefault(require("winston"));
 const express_winston_1 = __importDefault(require("express-winston"));
 const ecs_winston_format_1 = __importDefault(require("@elastic/ecs-winston-format"));
-let configs;
-try {
-    configs = require((0, process_1.cwd)() + '/logger.config');
-}
-catch {
-    throw Error("Logger configs could not be found on app root's directory.");
-}
-function filterRequestHeaders(confidentialHeaders = []) {
-    return (req, propName) => {
-        if (propName !== 'headers')
-            return req[propName];
-        const filteredHeaders = Object.keys(req.headers)
-            .filter(key => !confidentialHeaders.includes(key))
-            .reduce((acc, key) => {
-            acc[key] = req.headers[key];
-            return acc;
-        }, {});
-        return filteredHeaders;
-    };
-}
-const routeFilter = (req, res) => {
-    const { url } = req;
-    const routesToBeFiltered = configs.ignoredRoutes || [];
-    const shouldRouteBeFiltered = shouldFilterRoute(url, routesToBeFiltered);
-    return shouldRouteBeFiltered;
-};
-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 getTransports() {
-    const transports = [];
-    if (configs.console) {
-        transports.push(new winston_1.default.transports.Console(configs.console));
-    }
-    if (configs.file) {
-        transports.push(new winston_1.default.transports.File(configs.file));
-    }
-    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 shouldRouteBeFiltered(request, blacklistedRoutes) {
-    return 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());
-    });
-}
-function filterBlacklistedBodysByRoute(info) {
-    var _a, _b;
-    const blacklistedResponseRoutes = configs.responseBlacklistBodyRoutes || [];
-    const blacklistedRequestRoutes = configs.requestBlacklistBodyRoutes || [];
-    const request = info.meta.req;
-    const shouldResponseBeFiltered = shouldRouteBeFiltered(request, blacklistedResponseRoutes);
-    const shouldRequestBeFiltered = shouldRouteBeFiltered(request, blacklistedRequestRoutes);
-    if (shouldResponseBeFiltered) {
-        (_a = info.meta.res) === null || _a === void 0 ? true : delete _a.body;
-    }
-    if (shouldRequestBeFiltered) {
-        (_b = info.meta.req) === null || _b === void 0 ? true : delete _b.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;
-    })();
-}
+const config_1 = require("./config");
+const error_1 = require("./formatters/error");
+const blacklist_1 = require("./formatters/blacklist");
+const request_1 = require("./utils/request");
+const route_1 = require("./utils/route");
+const transports_1 = require("./transports");
+let loggerInstance = null;
 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", ...(config_1.configs.requestWhitelist || []));
+    express_winston_1.default.responseWhitelist.push("body", ...(config_1.configs.responseWhitelist || []));
     return express_winston_1.default.logger({
         statusLevels: true,
-        transports: getTransports(),
-        requestFilter: filterRequestHeaders(configs.confidentialHeaders || []),
-        ignoreRoute: routeFilter,
-        format: winston_1.default.format.combine(formatBlacklistedBody(), (0, ecs_winston_format_1.default)({ convertReqRes: true })),
+        transports: (0, transports_1.getMiddlewareTransports)(),
+        requestFilter: (0, request_1.filterRequestHeaders)(config_1.configs.confidentialHeaders || []),
+        ignoreRoute: (req) => (0, route_1.shouldFilterRoute)(req.url, config_1.configs.ignoredRoutes || []),
+        format: winston_1.default.format.combine((0, blacklist_1.formatBlacklistedBody)(), error_1.errorFormatter, (0, ecs_winston_format_1.default)({ convertReqRes: true })),
     });
 }
 function createErrorLoggerMiddleware() {
     return express_winston_1.default.errorLogger({
-        format: (0, ecs_winston_format_1.default)({ convertReqRes: true }),
-        transports: getTransports(),
-        requestFilter: filterRequestHeaders(configs.confidentialHeaders || []),
+        format: winston_1.default.format.combine(error_1.errorFormatter, (0, ecs_winston_format_1.default)({ convertReqRes: true })),
+        transports: (0, transports_1.getMiddlewareTransports)(),
+        requestFilter: (0, request_1.filterRequestHeaders)(config_1.configs.confidentialHeaders || []),
+    });
+}
+function createLogger() {
+    if (loggerInstance) {
+        return loggerInstance;
+    }
+    const logger = winston_1.default.createLogger({
+        exitOnError: false,
+        format: winston_1.default.format.combine(error_1.errorFormatter, (0, ecs_winston_format_1.default)({ convertReqRes: true })),
+        transports: (0, transports_1.getLoggerTransports)(),
+    });
+    logger.stream = Object.assign(logger.stream, {
+        write(message) {
+            logger.info(JSON.parse(message));
+        },
     });
+    loggerInstance = logger;
+    return logger;
 }
+// Criar as instâncias uma única vez
 exports.loggerMiddleware = createLoggerMiddleware();
 exports.logError = createErrorLoggerMiddleware();
-exports.logger = winston_1.default.createLogger({
-    format: (0, ecs_winston_format_1.default)({ convertReqRes: true }),
-    transports: getTransports(),
-    exitOnError: false,
-});
-exports.logger.stream = Object.assign(exports.logger.stream, {
-    write(message) {
-        exports.logger.info(JSON.parse(message));
-    },
-});
+exports.logger = createLogger();

package/logger/transports/index.d.ts

@@ -0,0 +1,3 @@
+import winston from "winston";
+export declare function getMiddlewareTransports(): winston.transport[];
+export declare function getLoggerTransports(): winston.transport[];

package/logger/transports/index.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLoggerTransports = exports.getMiddlewareTransports = void 0;
+const winston_1 = __importDefault(require("winston"));
+const config_1 = require("../config");
+function getMiddlewareTransports() {
+    const transports = [];
+    if (config_1.configs.console) {
+        transports.push(new winston_1.default.transports.Console({
+            ...config_1.configs.console,
+            handleExceptions: false,
+            handleRejections: false,
+        }));
+    }
+    if (config_1.configs.file) {
+        transports.push(new winston_1.default.transports.File({
+            ...config_1.configs.file,
+            handleExceptions: false,
+            handleRejections: false,
+        }));
+    }
+    return transports;
+}
+exports.getMiddlewareTransports = getMiddlewareTransports;
+function getLoggerTransports() {
+    const transports = [];
+    if (config_1.configs.console) {
+        transports.push(new winston_1.default.transports.Console({
+            handleExceptions: true,
+            handleRejections: true,
+            ...config_1.configs.console,
+        }));
+    }
+    if (config_1.configs.file) {
+        transports.push(new winston_1.default.transports.File({
+            handleExceptions: true,
+            handleRejections: true,
+            ...config_1.configs.file,
+        }));
+    }
+    return transports;
+}
+exports.getLoggerTransports = getLoggerTransports;

package/logger/utils/request.d.ts

@@ -0,0 +1,3 @@
+import { FilterRequest } from "express-winston";
+export declare function filterRequestHeaders(confidentialHeaders?: string[]): (req: FilterRequest, propName: string) => any;
+export declare function isRequestInfo(info: any): boolean;

package/logger/utils/request.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRequestInfo = exports.filterRequestHeaders = void 0;
+function filterRequestHeaders(confidentialHeaders = []) {
+    return (req, propName) => {
+        if (propName !== "headers")
+            return req[propName];
+        const filteredHeaders = Object.keys(req.headers)
+            .filter((key) => !confidentialHeaders.includes(key))
+            .reduce((acc, key) => {
+            acc[key] = req.headers[key];
+            return acc;
+        }, {});
+        return filteredHeaders;
+    };
+}
+exports.filterRequestHeaders = filterRequestHeaders;
+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;
+}
+exports.isRequestInfo = isRequestInfo;

package/logger/utils/route.d.ts

@@ -0,0 +1,6 @@
+export declare function generateRouteRegex(route: string): RegExp;
+export declare function shouldFilterRoute(url: string, routesToBeFiltered: string[]): boolean;
+export declare function shouldRouteBeFiltered(request: any, blacklistedRoutes: {
+    route: string;
+    method: string;
+}[]): boolean;

package/logger/utils/route.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldRouteBeFiltered = exports.shouldFilterRoute = exports.generateRouteRegex = void 0;
+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("/");
+    return new RegExp("^/" + regexString + "$", "g");
+}
+exports.generateRouteRegex = generateRouteRegex;
+function shouldFilterRoute(url, routesToBeFiltered) {
+    return routesToBeFiltered.some((route) => {
+        const regExp = generateRouteRegex(route);
+        const matches = new String(url).match(regExp);
+        return !!(matches === null || matches === void 0 ? void 0 : matches.length);
+    });
+}
+exports.shouldFilterRoute = shouldFilterRoute;
+function shouldRouteBeFiltered(request, blacklistedRoutes) {
+    return 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());
+    });
+}
+exports.shouldRouteBeFiltered = shouldRouteBeFiltered;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sm-utility",
-  "version": "2.4.21",
+  "version": "2.4.23",
   "description": "reusable utility codes for sm projects",
   "main": "index.js",
   "types": "./index.d.ts",
@@ -21,6 +21,7 @@
   "devDependencies": {
     "@types/express": "^4.17.11",
     "@types/node": "^14.14.40",
+    "@types/request-ip": "0.0.41",
     "@types/uuid": "^8.3.1",
     "copyfiles": "^2.4.1",
     "typescript": "^4.2.4"
@@ -36,11 +37,12 @@
     "@opentelemetry/resources": "1.30.1",
     "@opentelemetry/sdk-node": "0.57.1",
     "@opentelemetry/sdk-trace-base": "1.30.1",
-    "axios": "1.7.8",
+    "axios": "1.9.0",
     "express-winston": "^4.1.0",
     "nanoid": "^3.3.6",
     "node-xlsx": "^0.24.0",
     "redis": "^4.1.0",
+    "request-ip": "3.3.0",
     "ts-node": "^10.9.1",
     "uuid": "^8.3.2",
     "winston": "^3.3.3"

package/request/axios-custom-client.d.ts

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

package/request/axios-custom-client.js

@@ -5,91 +5,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createApi = void 0;
 const axios_1 = __importDefault(require("axios"));
-const uuid_1 = require("uuid");
-const logger_1 = require("../logger");
+const request_interceptor_1 = require("./interceptors/request.interceptor");
+const response_interceptor_1 = require("./interceptors/response.interceptor");
+const error_interceptor_1 = require("./interceptors/error.interceptor");
 function createApi(axiosConfig) {
     const axiosApi = axios_1.default.create(axiosConfig);
-    axiosApi.interceptors.request.use();
-    axiosApi.interceptors.request.use((request) => {
-        if (request === null || request === void 0 ? void 0 : request.logRequest) {
-            const { data, params, method } = request;
-            const fullUrl = getFullUrlFromConfig(request);
-            request.meta = request.meta || {};
-            request.meta.requestId = (0, uuid_1.v4)();
-            request.meta.requestStartedAt = new Date().getTime();
-            logRequest(request.meta.requestId, method, fullUrl, data, params);
-        }
-        return request;
-    }, (error) => {
-        const { config, message, response } = error;
-        const { method, meta } = config || {};
-        const fullUrl = getFullUrlFromConfig(config);
-        logError(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, response === null || response === void 0 ? void 0 : response.data, response === null || response === void 0 ? void 0 : response.status, message);
-        throw error;
-    });
-    axiosApi.interceptors.response.use((response) => {
-        var _a;
-        if ((_a = response.config) === null || _a === void 0 ? void 0 : _a.logResponse) {
-            const { status, data, config } = response;
-            const { method, meta } = config;
-            const fullUrl = getFullUrlFromConfig(config);
-            const responseTime = getResponseTimeFromConfig(config);
-            logResponse(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, data, status, responseTime);
-        }
-        return response;
-    }, (error) => {
-        const { config, message, response } = error;
-        const { method, meta } = config || {};
-        const fullUrl = getFullUrlFromConfig(config);
-        logError(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, response === null || response === void 0 ? void 0 : response.data, response === null || response === void 0 ? void 0 : response.status, message);
-        throw error;
-    });
+    axiosApi.interceptors.request.use((0, request_interceptor_1.createRequestInterceptor)(), (0, error_interceptor_1.createErrorInterceptor)());
+    axiosApi.interceptors.response.use((0, response_interceptor_1.createResponseInterceptor)(), (0, error_interceptor_1.createErrorInterceptor)());
     return axiosApi;
 }
 exports.createApi = createApi;
-function logRequest(id, method, url, body, params) {
-    const request = {
-        ['context-id']: id,
-        url,
-        method: method === null || method === void 0 ? void 0 : method.toUpperCase(),
-        params,
-        body
-    };
-    logger_1.logger.info('sm-utility/api-request', { request });
-}
-function logResponse(id, method, url, body, status, responseTime) {
-    const response = {
-        ['context-id']: id,
-        url,
-        method: method === null || method === void 0 ? void 0 : method.toUpperCase(),
-        body,
-        status,
-        responseTime
-    };
-    logger_1.logger.info('sm-utility/api-response', { response });
-}
-function logError(id, method, url, data, status, message) {
-    const err = {
-        ['context-id']: id,
-        url,
-        method: method === null || method === void 0 ? void 0 : method.toUpperCase(),
-        data,
-        status,
-        message
-    };
-    logger_1.logger.error('sm-utility/api-error', { err });
-}
-function getResponseTimeFromConfig(config) {
-    var _a;
-    const requestStart = (_a = config === null || config === void 0 ? void 0 : config.meta) === null || _a === void 0 ? void 0 : _a.requestStartedAt;
-    let responseTime = '-';
-    if (requestStart) {
-        responseTime = String(new Date().getTime() - requestStart);
-    }
-    return responseTime + ' ms';
-}
-function getFullUrlFromConfig(config) {
-    const { baseURL, url } = config || {};
-    const fullUrl = baseURL && url ? new String().concat(baseURL, url) : '';
-    return fullUrl;
-}

package/request/index.d.ts

@@ -1,3 +1,4 @@
 export * from './axios-custom-client';
 export * from './axios';
 export * from './types';
+export * from './requestExtractor';

package/request/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./axios-custom-client"), exports);
 __exportStar(require("./axios"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./requestExtractor"), exports);

package/request/interceptors/error.interceptor.d.ts

@@ -0,0 +1,2 @@
+import { AxiosError } from "axios";
+export declare function createErrorInterceptor(): (error: AxiosError) => never;

package/request/interceptors/error.interceptor.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createErrorInterceptor = void 0;
+const loggers_1 = require("../loggers");
+const utils_1 = require("../utils");
+function createErrorInterceptor() {
+    return (error) => {
+        const { config, message, response } = error;
+        const { method, meta } = config || {};
+        const fullUrl = (0, utils_1.getFullUrlFromConfig)(config);
+        (0, loggers_1.logError)(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, response === null || response === void 0 ? void 0 : response.data, response === null || response === void 0 ? void 0 : response.status, message);
+        throw error;
+    };
+}
+exports.createErrorInterceptor = createErrorInterceptor;

package/request/interceptors/request.interceptor.d.ts

@@ -0,0 +1,2 @@
+import { InternalAxiosRequestConfig } from "axios";
+export declare function createRequestInterceptor(): (request: InternalAxiosRequestConfig) => InternalAxiosRequestConfig<any>;

package/request/interceptors/request.interceptor.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRequestInterceptor = void 0;
+const uuid_1 = require("uuid");
+const utils_1 = require("../utils");
+const loggers_1 = require("../loggers");
+function createRequestInterceptor() {
+    return (request) => {
+        if (request === null || request === void 0 ? void 0 : request.logRequest) {
+            const { data, params, method } = request;
+            const fullUrl = (0, utils_1.getFullUrlFromConfig)(request);
+            request.meta = request.meta || {};
+            request.meta.requestId = (0, uuid_1.v4)();
+            request.meta.requestStartedAt = new Date().getTime();
+            (0, loggers_1.logRequest)(request.meta.requestId, method, fullUrl, data, params);
+        }
+        return request;
+    };
+}
+exports.createRequestInterceptor = createRequestInterceptor;

package/request/interceptors/response.interceptor.d.ts

@@ -0,0 +1,2 @@
+import { AxiosResponse } from "axios";
+export declare function createResponseInterceptor(): (response: AxiosResponse) => AxiosResponse<any, any>;

package/request/interceptors/response.interceptor.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createResponseInterceptor = void 0;
+const loggers_1 = require("../loggers");
+const utils_1 = require("../utils");
+function createResponseInterceptor() {
+    return (response) => {
+        var _a;
+        if ((_a = response.config) === null || _a === void 0 ? void 0 : _a.logResponse) {
+            const { status, data, config } = response;
+            const { method, meta } = config;
+            const fullUrl = (0, utils_1.getFullUrlFromConfig)(config);
+            const responseTime = (0, utils_1.getResponseTimeFromConfig)(config);
+            (0, loggers_1.logResponse)(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, data, status, responseTime);
+        }
+        return response;
+    };
+}
+exports.createResponseInterceptor = createResponseInterceptor;

package/request/loggers/error.logger.d.ts

@@ -0,0 +1 @@
+export declare function logError(id: string, method: string | undefined, url: string | undefined, data: unknown, status: any, message: any): void;

package/request/loggers/error.logger.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logError = void 0;
+const logger_1 = require("../../logger");
+function logError(id, method, url, data, status, message) {
+    const err = {
+        ["context-id"]: id,
+        url,
+        method: method === null || method === void 0 ? void 0 : method.toUpperCase(),
+        data,
+        status,
+        message,
+    };
+    logger_1.logger.error("sm-utility/api-error", { err });
+}
+exports.logError = logError;

package/request/loggers/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./error.logger";
+export * from "./request.logger";
+export * from "./response.logger";

package/request/loggers/index.js

@@ -0,0 +1,19 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./error.logger"), exports);
+__exportStar(require("./request.logger"), exports);
+__exportStar(require("./response.logger"), exports);

package/request/loggers/request.logger.d.ts

@@ -0,0 +1 @@
+export declare function logRequest(id: string, method: string | undefined, url: string | undefined, body: unknown, params: string): void;

package/request/loggers/request.logger.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logRequest = void 0;
+const logger_1 = require("../../logger");
+function logRequest(id, method, url, body, params) {
+    const request = {
+        ["context-id"]: id,
+        url,
+        method: method === null || method === void 0 ? void 0 : method.toUpperCase(),
+        params,
+        body,
+    };
+    logger_1.logger.info("sm-utility/api-request", { request });
+}
+exports.logRequest = logRequest;

package/request/loggers/response.logger.d.ts

@@ -0,0 +1 @@
+export declare function logResponse(id: string, method: string | undefined, url: string | undefined, body: unknown, status: any, responseTime: string): void;

package/request/loggers/response.logger.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logResponse = void 0;
+const logger_1 = require("../../logger");
+function logResponse(id, method, url, body, status, responseTime) {
+    const response = {
+        ["context-id"]: id,
+        url,
+        method: method === null || method === void 0 ? void 0 : method.toUpperCase(),
+        body,
+        status,
+        responseTime,
+    };
+    logger_1.logger.info("sm-utility/api-response", { response });
+}
+exports.logResponse = logResponse;

package/request/requestExtractor.d.ts

@@ -0,0 +1,25 @@
+import { Request } from 'express';
+export declare class IpAddress {
+    private readonly ip;
+    constructor(ip: string | null);
+    raw(): string;
+    sanitized(): string;
+}
+export declare class RequestExtractor {
+    private readonly req;
+    constructor(req: Request);
+    /**
+     * Extracts the ip address from the request headers.
+     *
+     * If the ip address is not in the cf-connecting-ip header (Cloudflare - HML and PROD), it will be extracted from the x-forwarded-for header (local development)
+     */
+    extractIp(): IpAddress;
+    /**
+     * Extracts the trace id (x-ray trace id) from the request headers
+     */
+    extractTraceId(): string | undefined;
+    /**
+     * Extracts the user agent from the request headers
+     */
+    extractUserAgent(): string | undefined;
+}

package/request/requestExtractor.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestExtractor = exports.IpAddress = void 0;
+const request_ip_1 = __importDefault(require("request-ip"));
+class IpAddress {
+    constructor(ip) {
+        this.ip = ip;
+    }
+    raw() {
+        return this.ip || 'unknown';
+    }
+    sanitized() {
+        var _a;
+        return ((_a = this.ip) === null || _a === void 0 ? void 0 : _a.replace(/^::ffff:/, '')) || 'unknown';
+    }
+}
+exports.IpAddress = IpAddress;
+class RequestExtractor {
+    constructor(req) {
+        this.req = req;
+    }
+    /**
+     * Extracts the ip address from the request headers.
+     *
+     * If the ip address is not in the cf-connecting-ip header (Cloudflare - HML and PROD), it will be extracted from the x-forwarded-for header (local development)
+     */
+    extractIp() {
+        const cloudflareIp = this.req.headers['cf-connecting-ip'];
+        const ip = cloudflareIp || request_ip_1.default.getClientIp(this.req);
+        return new IpAddress(ip);
+    }
+    /**
+     * Extracts the trace id (x-ray trace id) from the request headers
+     */
+    extractTraceId() {
+        return this.req.headers['x-amzn-trace-id'];
+    }
+    /**
+     * Extracts the user agent from the request headers
+     */
+    extractUserAgent() {
+        var _a;
+        return (_a = this.req) === null || _a === void 0 ? void 0 : _a.headers['user-agent'];
+    }
+}
+exports.RequestExtractor = RequestExtractor;

package/request/utils.d.ts

@@ -0,0 +1,3 @@
+import { AxiosRequestConfig, InternalAxiosRequestConfig } from "axios";
+export declare function getFullUrlFromConfig(config: InternalAxiosRequestConfig | undefined): string;
+export declare function getResponseTimeFromConfig(config: AxiosRequestConfig): string;

package/request/utils.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getResponseTimeFromConfig = exports.getFullUrlFromConfig = void 0;
+function getFullUrlFromConfig(config) {
+    const { baseURL, url } = config || {};
+    const fullUrl = baseURL && url ? new String().concat(baseURL, url) : "";
+    return fullUrl;
+}
+exports.getFullUrlFromConfig = getFullUrlFromConfig;
+function getResponseTimeFromConfig(config) {
+    var _a;
+    const requestStart = (_a = config === null || config === void 0 ? void 0 : config.meta) === null || _a === void 0 ? void 0 : _a.requestStartedAt;
+    let responseTime = "-";
+    if (requestStart) {
+        responseTime = String(new Date().getTime() - requestStart);
+    }
+    return responseTime + " ms";
+}
+exports.getResponseTimeFromConfig = getResponseTimeFromConfig;