sm-utility 2.4.28-beta.3 → 2.4.29

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sm-utility",
-  "version": "2.4.28-beta.3",
+  "version": "2.4.29",
   "description": "reusable utility codes for sm projects",
   "main": "index.js",
   "types": "./index.d.ts",

package/request/axios-custom-client.js

@@ -9,8 +9,9 @@ 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 instanceSanitizeKeys = (axiosConfig === null || axiosConfig === void 0 ? void 0 : axiosConfig.sanitizeKeys) || [];
     const axiosApi = axios_1.default.create(axiosConfig);
-    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)());
+    axiosApi.interceptors.request.use((0, request_interceptor_1.createRequestInterceptor)(instanceSanitizeKeys), (0, error_interceptor_1.createErrorInterceptor)(instanceSanitizeKeys));
+    axiosApi.interceptors.response.use((0, response_interceptor_1.createResponseInterceptor)(instanceSanitizeKeys), (0, error_interceptor_1.createErrorInterceptor)(instanceSanitizeKeys));
     return axiosApi;
 }

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

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

package/request/interceptors/error.interceptor.js

@@ -3,12 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createErrorInterceptor = createErrorInterceptor;
 const loggers_1 = require("../loggers");
 const utils_1 = require("../utils");
-function createErrorInterceptor() {
+const sanitizer_1 = require("../sanitizer");
+function createErrorInterceptor(instanceSanitizeKeys = []) {
     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);
+        const sanitizeKeys = (0, sanitizer_1.mergeSanitizeKeys)(instanceSanitizeKeys, config === null || config === void 0 ? void 0 : config.sanitizeKeys);
+        (0, loggers_1.logError)(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, (0, sanitizer_1.sanitizeValueByKeys)(response === null || response === void 0 ? void 0 : response.data, sanitizeKeys), response === null || response === void 0 ? void 0 : response.status, message);
         throw error;
     };
 }

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

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

package/request/interceptors/request.interceptor.js

@@ -4,15 +4,17 @@ exports.createRequestInterceptor = createRequestInterceptor;
 const uuid_1 = require("uuid");
 const utils_1 = require("../utils");
 const loggers_1 = require("../loggers");
-function createRequestInterceptor() {
+const sanitizer_1 = require("../sanitizer");
+function createRequestInterceptor(instanceSanitizeKeys = []) {
     return (request) => {
         if (request === null || request === void 0 ? void 0 : request.logRequest) {
             const { data, params, method } = request;
             const fullUrl = (0, utils_1.getFullUrlFromConfig)(request);
+            const sanitizeKeys = (0, sanitizer_1.mergeSanitizeKeys)(instanceSanitizeKeys, request.sanitizeKeys);
             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);
+            (0, loggers_1.logRequest)(request.meta.requestId, method, fullUrl, (0, sanitizer_1.sanitizeValueByKeys)(data, sanitizeKeys), (0, sanitizer_1.sanitizeValueByKeys)(params, sanitizeKeys));
         }
         return request;
     };

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

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

package/request/interceptors/response.interceptor.js

@@ -3,7 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createResponseInterceptor = createResponseInterceptor;
 const loggers_1 = require("../loggers");
 const utils_1 = require("../utils");
-function createResponseInterceptor() {
+const sanitizer_1 = require("../sanitizer");
+function createResponseInterceptor(instanceSanitizeKeys = []) {
     return (response) => {
         var _a;
         if ((_a = response.config) === null || _a === void 0 ? void 0 : _a.logResponse) {
@@ -11,7 +12,8 @@ function createResponseInterceptor() {
             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);
+            const sanitizeKeys = (0, sanitizer_1.mergeSanitizeKeys)(instanceSanitizeKeys, config.sanitizeKeys);
+            (0, loggers_1.logResponse)(meta === null || meta === void 0 ? void 0 : meta.requestId, method, fullUrl, (0, sanitizer_1.sanitizeValueByKeys)(data, sanitizeKeys), status, responseTime);
         }
         return response;
     };

package/request/sanitizer.d.ts

@@ -0,0 +1,2 @@
+export declare function mergeSanitizeKeys(instanceKeys?: string[], requestKeys?: string[]): string[];
+export declare function sanitizeValueByKeys<T>(value: T, sanitizeKeys?: string[]): T;

package/request/sanitizer.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeSanitizeKeys = mergeSanitizeKeys;
+exports.sanitizeValueByKeys = sanitizeValueByKeys;
+function isObjectLike(value) {
+    return typeof value === "object" && value !== null;
+}
+function maskString(value) {
+    if (!value.length) {
+        return value;
+    }
+    const visibleLength = Math.max(1, Math.ceil(value.length * 0.2));
+    const visiblePart = value.slice(0, visibleLength);
+    const maskedPart = "*".repeat(Math.max(0, value.length - visibleLength));
+    return visiblePart + maskedPart;
+}
+function maskSanitizedValue(value) {
+    if (value === null || value === undefined) {
+        return value;
+    }
+    if (Array.isArray(value)) {
+        return value.map((item) => maskSanitizedValue(item));
+    }
+    if (isObjectLike(value)) {
+        const maskedObject = {};
+        for (const [key, nestedValue] of Object.entries(value)) {
+            maskedObject[key] = maskSanitizedValue(nestedValue);
+        }
+        return maskedObject;
+    }
+    return maskString(String(value));
+}
+function mergeSanitizeKeys(instanceKeys = [], requestKeys = []) {
+    return Array.from(new Set([...instanceKeys, ...requestKeys]));
+}
+function sanitizeValueByKeys(value, sanitizeKeys = []) {
+    if (!sanitizeKeys.length || !isObjectLike(value)) {
+        return value;
+    }
+    const keySet = new Set(sanitizeKeys);
+    const visited = new WeakMap();
+    const sanitizeRecursive = (currentValue) => {
+        if (!isObjectLike(currentValue)) {
+            return currentValue;
+        }
+        if (visited.has(currentValue)) {
+            return visited.get(currentValue);
+        }
+        if (Array.isArray(currentValue)) {
+            const sanitizedArray = [];
+            visited.set(currentValue, sanitizedArray);
+            for (const item of currentValue) {
+                sanitizedArray.push(sanitizeRecursive(item));
+            }
+            return sanitizedArray;
+        }
+        const sanitizedObject = {};
+        visited.set(currentValue, sanitizedObject);
+        for (const [key, nestedValue] of Object.entries(currentValue)) {
+            sanitizedObject[key] = keySet.has(key)
+                ? maskSanitizedValue(nestedValue)
+                : sanitizeRecursive(nestedValue);
+        }
+        return sanitizedObject;
+    };
+    return sanitizeRecursive(value);
+}

package/request/types.d.ts

@@ -5,6 +5,7 @@ declare module 'axios' {
         meta?: Record<string, any>;
         logRequest?: boolean;
         logResponse?: boolean;
+        sanitizeKeys?: string[];
     }
 }
 export type CustomClientCreateApiParams = Omit<AxiosRequestConfig, 'meta'>;