@cley_faye/boilerplate 3.7.0 → 3.7.1

package/lib/express/middlewares/bodylogger.d.ts

@@ -2,4 +2,8 @@ import { NextFunction, Request, Response } from "express";
 export declare type ExtraLoggingDataType = Record<string, unknown> | undefined;
 export declare type ExtraLoggingDataFunc = (req: Request) => Promise<ExtraLoggingDataType> | ExtraLoggingDataType;
 export declare type ExtraLoggingData = ExtraLoggingDataFunc | Record<string, unknown>;
-export declare const bodyLogger: (bodyProps?: string[] | undefined, extraLoggingData?: ExtraLoggingData | undefined) => (req: Request, res: Response, next: NextFunction) => void;
+export interface ExtraLoggingOptions {
+    /** Do not expose the "hidden" body props */
+    noHiddenBodyProps?: boolean;
+}
+export declare const bodyLogger: (bodyProps?: string[] | undefined, extraLoggingData?: ExtraLoggingData | undefined, options?: ExtraLoggingOptions) => (req: Request, res: Response, next: NextFunction) => void;

package/lib/express/middlewares/bodylogger.js

@@ -38,12 +38,46 @@ const setLogInfoInReq = (req, body, extraData) => {
         castReq._cleyfayeLogging = { extraLoggingData: extraData };
     }
 };
-const bodyLogger = (bodyProps, extraLoggingData) => (req, res, next) => {
+const getPropType = (value) => {
+    if (typeof value === "string")
+        return `string(${value.length})`;
+    if (typeof value === "number")
+        return "number";
+    if (typeof value === "boolean")
+        return "boolean";
+    if (typeof value === "undefined")
+        return "undefined";
+    if (Array.isArray(value))
+        return `Array(${value.length})`;
+    return "object";
+};
+const getHiddenBodyProps = (req, ignoreKeys = []) => {
+    if (typeof req.body !== "object")
+        return;
+    const body = req.body;
+    const res = {};
+    for (const key of Object.keys(body)) {
+        if (ignoreKeys.includes(key))
+            continue;
+        res[key] = getPropType(body[key]);
+    }
+    if (Object.keys(res).length === 0)
+        return;
+    return res;
+};
+const bodyLogger = (bodyProps, extraLoggingData, options = {}) => (req, res, next) => {
     const asyncFunc = async () => {
+        const allExtraData = {};
+        if (!options.noHiddenBodyProps) {
+            const redactedBody = getHiddenBodyProps(req, bodyProps);
+            if (redactedBody)
+                Object.assign(allExtraData, { redactedBody });
+        }
         const extraLogData = typeof extraLoggingData === "function"
             ? await extraLoggingData(req)
             : extraLoggingData;
-        setLogInfoInReq(req, bodyProps, extraLogData);
+        Object.assign(allExtraData, extraLogData);
+        setLogInfoInReq(req, bodyProps, allExtraData);
     };
     asyncFunc()
         .then(() => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cley_faye/boilerplate",
-  "version": "3.7.0",
+  "version": "3.7.1",
   "description": "Boilerplate code generator for generic projects",
   "repository": {
     "type": "git",