@cley_faye/boilerplate 3.7.2 → 3.9.1

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

@@ -1,7 +1,7 @@
 import expressWinston, { BaseLoggerOptions } from "express-winston";
 import { Request, Router } from "express";
 import { LogOptions, UserFromReqFunc } from "./pipelinebuilder.js";
-export declare type LoggerOptions = expressWinston.LoggerOptions | boolean;
+export declare type LoggerOptions = expressWinston.BaseLoggerOptions | boolean;
 interface ErrorLoggerConfiguration {
     collapseNodeModules?: boolean;
 }
@@ -16,7 +16,7 @@ export interface RequestWithLoggingData extends Request {
     };
 }
 /** Return the default value for route logger is it is set as `true` */
-export declare const defaultRouteLoggerConfig: (userFromReq?: UserFromReqFunc | undefined) => BaseLoggerOptions;
-export declare const registerRouteLogger: (app: Router, logOptions?: LogOptions | undefined) => void;
-export declare const registerErrorLogger: (app: Router, logOptions?: LogOptions | undefined) => void;
+export declare const defaultRouteLoggerConfig: (userFromReq?: UserFromReqFunc) => BaseLoggerOptions;
+export declare const registerRouteLogger: (app: Router, logOptions?: LogOptions) => void;
+export declare const registerErrorLogger: (app: Router, logOptions?: LogOptions) => void;
 export {};

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

@@ -6,4 +6,4 @@ 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;
+export declare const bodyLogger: (bodyProps?: Array<string>, extraLoggingData?: ExtraLoggingData, options?: ExtraLoggingOptions) => (req: Request, res: Response, next: NextFunction) => void;

package/lib/express.d.ts

@@ -99,14 +99,23 @@ import { PipelineSettings, LogFunction } from "./express/pipelinebuilder.js";
  * @return
  * The returned object can be used
  */
-export declare const createPipeline: (settings: PipelineSettings, debugLog?: LogFunction | undefined) => express.Router;
+export declare const createPipeline: (settings: PipelineSettings, debugLog?: LogFunction) => express.Router;
 /**
  * Configure the views rendering engine for an ExpressJS App
  */
-export declare const setViewEngine: (app: express.Express, viewEngine: string, viewsDirectory: string, extraLocals?: Record<string, string | number> | undefined) => void;
+export declare const setViewEngine: (app: express.Express, viewEngine: string, viewsDirectory: string, extraLocals?: Record<string, string | number>) => 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/webpack.d.ts

@@ -27,7 +27,7 @@ export interface WebpackLoadersOptions {
  * Version of core-js to use (default to 3)
  *
  * @param [options.babel.targets]
- * Browser targets (default to "last 1 version, > 2%, not dead")
+ * Browser targets (default to " > 1%, last 1 safari version")
  *
  * @param [options.babel.plugins]
  * Plugins to add to babel

package/lib/grunt/reactapp/webpack.js

@@ -49,7 +49,7 @@ const defaultLoadersDefine = (options) => [
 const defaultLoadersPresetEnv = (options) => [
     "@babel/preset-env",
     {
-        targets: (options.babel?.targets) ?? "last 1 version, > 2%, not dead",
+        targets: (options.babel?.targets) ?? "> 1%, last 1 safari version",
         useBuiltIns: "usage",
         corejs: (options.babel?.corejs) ?? defaultCoreJS,
         modules: false,
@@ -75,7 +75,7 @@ const defaultLoadersReact = (options) => [
  * Version of core-js to use (default to 3)
  *
  * @param [options.babel.targets]
- * Browser targets (default to "last 1 version, > 2%, not dead")
+ * Browser targets (default to " > 1%, last 1 safari version")
  *
  * @param [options.babel.plugins]
  * Plugins to add to babel

package/lib/grunt/reactapp.d.ts

@@ -85,7 +85,7 @@ export declare type HandlerFunction = (gruntConfig: GruntConfig, targetName: str
  * @return
  * List of tasks to build the application
  */
-export declare const reactApp: (gruntConfig: GruntConfig, targetName?: string, options?: ReactAppOptions | undefined) => Array<string>;
+export declare const reactApp: (gruntConfig: GruntConfig, targetName?: string, options?: ReactAppOptions) => Array<string>;
 export interface HelperOptions {
     production?: boolean;
     watch?: boolean | number;

package/lib/winston.js

@@ -70,7 +70,7 @@ const logConfig = {
     collapseNodeModules: true,
 };
 const customFormat = winston_1.default.format.printf((info) => {
-    const message = ("stack" in info) ? info.stack : info.message;
+    const message = (("stack" in info) ? info.stack : info.message);
     const filteredMessage = logConfig.collapseNodeModules
         ? [...(0, exports.filterNodeModules)(message)].join("\n")
         : message;

package/package.json

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