@cley_faye/boilerplate 3.7.0 → 3.8.0

package/README.md

@@ -426,7 +426,7 @@ import {appStart} from "@cley_faye/boilerplate/lib/express.js";
 
 appStart({
   app,
-  allowNonLocal: false,
+  listenInterface: false,
   port: 3000,
   shutdownFunction: () => {;},
   logger: consoleLogger,
@@ -435,7 +435,8 @@ appStart({
 
 The settings are:
 
-- allowNonLocal: listen only to localhost or not
+- listenInterface: listen only to localhost or not. Can also be used to specify the address of an
+  interface to bind to.
 - port: port to listen to. Can be 0 to use a random available port
 - shutdownFunction: a function to call after the server stop listening
 - logger: a winston logger to log that the server started listening

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/lib/express.d.ts

@@ -106,7 +106,16 @@ export declare const createPipeline: (settings: PipelineSettings, debugLog?: Log
 export declare const setViewEngine: (app: express.Express, viewEngine: string, viewsDirectory: string, extraLocals?: Record<string, string | number> | undefined) => void;
 export interface StartDefinition {
     app: express.Application;
+    /** @deprecated use listenInterface instead */
     allowNonLocal?: boolean;
+    /**
+     * Which interface to listen on.
+     *
+     * Defaults to `false` which means listen only on localhost.
+     * Set to `true` to listen on all interfaces
+     * Set to an IP to bind on a specific interface.
+     */
+    listenInterface?: boolean | string;
     port?: number;
     shutdownFunction?: () => void;
     logger?: winston.Logger;
@@ -135,4 +144,4 @@ export interface StartResult {
  *
  * @property server
  */
-export declare const appStart: ({ app, allowNonLocal, port, shutdownFunction, logger, }: StartDefinition) => Promise<StartResult>;
+export declare const appStart: ({ app, allowNonLocal, listenInterface, port, shutdownFunction, logger, }: StartDefinition) => Promise<StartResult>;

package/lib/express.js

@@ -169,7 +169,7 @@ exports.setViewEngine = setViewEngine;
  *
  * @property server
  */
-const appStart = ({ app, allowNonLocal, port, shutdownFunction, logger, }) => new Promise(resolve => {
+const appStart = ({ app, allowNonLocal, listenInterface, port, shutdownFunction, logger, }) => new Promise(resolve => {
     let server = null;
     const readyCallback = () => {
         if (server === null) {
@@ -186,9 +186,18 @@ const appStart = ({ app, allowNonLocal, port, shutdownFunction, logger, }) => ne
             server,
         });
     };
-    server = allowNonLocal
-        ? app.listen(port ?? 0, readyCallback)
-        : app.listen(port ?? 0, "localhost", readyCallback);
+    if (allowNonLocal !== undefined && listenInterface !== undefined) {
+        throw new Error("You can't specify both allowNonLocal and listenInterface at the same time");
+    }
+    if (allowNonLocal || listenInterface === true) {
+        server = app.listen(port ?? 0, readyCallback);
+    }
+    else if (typeof listenInterface === "string") {
+        server = app.listen(port ?? 0, listenInterface, readyCallback);
+    }
+    else {
+        server = app.listen(port ?? 0, "localhost", readyCallback);
+    }
     if (shutdownFunction) {
         server.on("close", shutdownFunction);
     }

package/lib/grunt/reactapp.js

@@ -49,7 +49,7 @@ var HandlerType;
     HandlerType["COPY"] = "copy";
 })(HandlerType = exports.HandlerType || (exports.HandlerType = {}));
 const gatherTasks = (handlers, gruntConfig, targetName, options) => Object.keys(handlers)
-    .reduce((acc, cur) => acc.concat((options?.[cur] && (options[cur] ?? {}).disabled)
+    .reduce((acc, cur) => acc.concat((options?.[cur] && options[cur]?.disabled)
     ? []
     : handlers[cur](gruntConfig, targetName, (options?.[cur]) ?? {})), []);
 const mergeResults = (tasksResults) => tasksResults.reduce((acc, cur) => {
@@ -184,7 +184,8 @@ const reactApp = (gruntConfig, targetName = "reactApp", options) => {
     };
     const tasksResults = gatherTasks(handlers, gruntConfig, targetName, options);
     const mergedResults = mergeResults(tasksResults);
-    createCopyTask(gruntConfig, targetName, mergedResults, options);
+    if (!options?.copy?.disabled)
+        createCopyTask(gruntConfig, targetName, mergedResults, options);
     // Add grunt-contrib-watch task
     createWatchTasks(gruntConfig, mergedResults, options?.watch);
     return mergedResults.requiredTasks;

package/package.json

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