@cley_faye/boilerplate 3.12.1 → 3.13.0

package/README.md

@@ -407,9 +407,11 @@ router.post(
 In addition to excluding properties from the body of a request and adding custom properties, it can
 be useful to always identify a request coming from a logged-in user.
 
-You can provide a `userFromReq` property to the `options.log` configuration.
+You can provide a `authFromReq` property to the `options.log` configuration.
 It should be a function that receive `req` as its argument and returns a string identifying the
 logged-in user.
+(this only work with the default log handler; if you define anything in `route` you can set this in
+`dynamicMeta()`)
 
 ### Configuring global aspects of an Express App
 

package/lib/express/logger.d.ts

@@ -1,14 +1,14 @@
 import expressWinston, { BaseLoggerOptions } from "express-winston";
 import { Request, Router } from "express";
 import { LogOptions, UserFromReqFunc } from "./pipelinebuilder.js";
-export declare type LoggerOptions = expressWinston.BaseLoggerOptions | boolean;
+export type LoggerOptions = expressWinston.BaseLoggerOptions | boolean;
 interface ErrorLoggerConfiguration {
     /** @deprecated Use collapseStacktrace */
     collapseNodeModules?: boolean;
     collapseStacktrace?: boolean;
     extraFilter?: Array<RegExp> | RegExp;
 }
-export declare type ErrorLoggerOptions = ErrorLoggerConfiguration | boolean;
+export type ErrorLoggerOptions = ErrorLoggerConfiguration | boolean;
 export interface LoggingData {
     extraLoggingData?: Record<string, unknown>;
 }
@@ -19,7 +19,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) => BaseLoggerOptions;
+export declare const defaultRouteLoggerConfig: (authFromReq?: UserFromReqFunc) => BaseLoggerOptions;
 export declare const registerRouteLogger: (app: Router, logOptions?: LogOptions) => void;
 export declare const registerErrorLogger: (app: Router, logOptions?: LogOptions) => void;
 export {};

package/lib/express/logger.js

@@ -57,24 +57,34 @@ const customRouteFormat = (outputTimestamp) => winston_1.default.format.printf((
     return (0, winston_js_1.prefixOutput)(info.level, finalMessage, outputTimestamp);
 });
 /** Return the default value for route logger is it is set as `true` */
-const defaultRouteLoggerConfig = (userFromReq) => ({
+const defaultRouteLoggerConfig = (authFromReq) => ({
     meta: true,
     requestWhitelist: ["body"],
     responseWhitelist: [],
     dynamicMeta: (req) => {
         const castReq = req;
         const data = { ...castReq._cleyfayeLogging?.extraLoggingData };
-        if (userFromReq)
-            data.user = userFromReq(req) ?? null;
+        if (authFromReq) {
+            const value = authFromReq(req);
+            if (!value) {
+                data.auth = null;
+            }
+            else if (typeof value === "string") {
+                data.auth = value;
+            }
+            else {
+                Object.assign(data, value);
+            }
+        }
         return data;
     },
 });
 exports.defaultRouteLoggerConfig = defaultRouteLoggerConfig;
 const registerRouteLogger = (app, logOptions) => {
-    const { route, timestamp, userFromReq } = logOptions ?? {};
+    const { route, timestamp, userFromReq, authFromReq } = logOptions ?? {};
     let extraConfig;
     if (typeof route === "boolean") {
-        extraConfig = (0, exports.defaultRouteLoggerConfig)(userFromReq);
+        extraConfig = (0, exports.defaultRouteLoggerConfig)(authFromReq ?? userFromReq);
     }
     else {
         extraConfig = { ...route };

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

@@ -1,7 +1,7 @@
 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 type ExtraLoggingDataType = Record<string, unknown> | undefined;
+export type ExtraLoggingDataFunc = (req: Request) => Promise<ExtraLoggingDataType> | ExtraLoggingDataType;
+export type ExtraLoggingData = ExtraLoggingDataFunc | Record<string, unknown>;
 export interface ExtraLoggingOptions {
     /** Do not expose the "hidden" body props */
     noHiddenBodyProps?: boolean;

package/lib/express/pipelinebuilder.d.ts

@@ -2,36 +2,38 @@ import express, { Request } from "express";
 import { OptionsJson, OptionsUrlencoded, OptionsText, Options as OptionsRaw } from "body-parser";
 import winston from "winston";
 import { LoggerOptions, ErrorLoggerOptions } from "./logger.js";
-export declare type LogFunction = (...args: Array<string | number | Record<string, unknown>>) => void;
+export type LogFunction = (...args: Array<string | number | Record<string, unknown>>) => void;
 export interface MiddlewareOptions {
     urlencoded?: boolean | OptionsUrlencoded;
     text?: boolean | OptionsText;
     raw?: boolean | OptionsRaw;
     json?: boolean | OptionsJson;
 }
-export declare type ComplexRouteHandler = express.RequestHandler | express.Router | Array<express.RequestHandler>;
+export type ComplexRouteHandler = express.RequestHandler | express.Router | Array<express.RequestHandler>;
 export interface ComplexRouteDefinition {
     route: string;
     handler: ComplexRouteHandler;
     method?: "get" | "post" | "put" | "options";
 }
-export declare type RouteDefinition = ComplexRouteDefinition | express.RequestHandler;
-export declare type RouterDefinition = express.Router | RouteDefinition;
-export declare type RouterWithNullDef = RouterDefinition | null | undefined;
+export type RouteDefinition = ComplexRouteDefinition | express.RequestHandler;
+export type RouterDefinition = express.Router | RouteDefinition;
+export type RouterWithNullDef = RouterDefinition | null | undefined;
 export interface ComplexStaticDefinition {
     root: string;
     options?: Record<string, unknown>;
     route?: string;
 }
-export declare type StaticDefinition = ComplexStaticDefinition | string;
-export declare type UserFromReqFunc = (req: Request) => string | undefined;
+export type StaticDefinition = ComplexStaticDefinition | string;
+export type UserFromReqFunc = (req: Request) => string | Record<string, unknown> | undefined;
 export interface LogOptions {
     route?: LoggerOptions;
     error?: ErrorLoggerOptions;
     logger?: winston.Logger;
     timestamp?: boolean;
     extraStacktraceFilter?: Array<RegExp> | RegExp;
+    /** @deprecated Use `authFromReq` instead */
     userFromReq?: UserFromReqFunc;
+    authFromReq?: UserFromReqFunc;
 }
 export interface DefaultErrorHandlerConfig {
     /** Set to true to allow server errors without a code to be sent as-is in the response */

package/lib/grunt/args.d.ts

@@ -6,15 +6,15 @@ export declare enum OptType {
 /**
  * Possible value type for options from command line
  */
-export declare type OptValue = string | number | boolean;
+export type OptValue = string | number | boolean;
 /**
  * List of all configured options
  */
-export declare type Opts = Record<string, OptValue>;
+export type Opts = Record<string, OptValue>;
 /**
  * Raw value type from command line
  */
-export declare type RawOptValue = undefined | boolean | string;
+export type RawOptValue = undefined | boolean | string;
 /**
  * Interface to an option provider (usually Grunt itself)
  */
@@ -61,11 +61,11 @@ export interface OptionDefinitionBoolean extends OptionDefinitionBase {
 /**
  * All possible option definition types
  */
-export declare type OptionDefinition = OptionDefinitionString | OptionDefinitionNumber | OptionDefinitionBoolean;
+export type OptionDefinition = OptionDefinitionString | OptionDefinitionNumber | OptionDefinitionBoolean;
 /**
  * Expected options from command line
  */
-export declare type ConfigDefinition = Record<string, OptionDefinition>;
+export type ConfigDefinition = Record<string, OptionDefinition>;
 /**
  * Display help to the user
  */

package/lib/grunt/reactapp/pug.d.ts

@@ -1,7 +1,7 @@
 import { BaseOptions } from "../util.js";
 import { HandlerFunctionResult } from "../reactapp.js";
 import { GruntConfig } from "./util.js";
-export declare type DynamicDataFunc = () => Promise<Record<string, unknown>>;
+export type DynamicDataFunc = () => Promise<Record<string, unknown>>;
 export interface PugOptions extends BaseOptions {
     options?: Record<string, unknown>;
     sourcePath?: string;

package/lib/grunt/reactapp/util.d.ts

@@ -1,5 +1,5 @@
-export declare type DynamicTaskFunc = () => Promise<void>;
-export declare type GruntConfig = Record<string, Record<string, Record<string, unknown> | (() => void) | undefined>>;
+export type DynamicTaskFunc = () => Promise<void>;
+export type GruntConfig = Record<string, Record<string, Record<string, unknown> | (() => void) | undefined>>;
 /** Insert a new task in a grunt config object.
  *
  * @param gruntConfig

package/lib/grunt/reactapp.d.ts

@@ -31,7 +31,7 @@ export interface HandlerFunctionResult {
     handledFiles: Array<string>;
     watchTasks: Array<WatchTaskDef>;
 }
-export declare type HandlerFunction = (gruntConfig: GruntConfig, targetName: string, options: BaseOptions) => HandlerFunctionResult;
+export type HandlerFunction = (gruntConfig: GruntConfig, targetName: string, options: BaseOptions) => HandlerFunctionResult;
 /** Insert necessary build step for a React/Web app.
  *
  * This function will add the following Grunt tasks:

package/lib/grunt/reactapp.js

@@ -111,7 +111,7 @@ const createWatchTasks = (gruntConfig, mergedResults, watchMode) => {
                     ? ""
                     : "webres/";
                 if (cur.startsWith("!")) {
-                    acc.push(`!${prefix}${cur.substr(1)}`);
+                    acc.push(`!${prefix}${cur.substring(1)}`);
                 }
                 else {
                     acc.push(`${prefix}${cur}`);

package/lib/grunt/util.d.ts

@@ -1,8 +1,8 @@
 export interface BaseOptions {
     disabled?: boolean;
 }
-export declare type ConfigValue = string | number | boolean | Record<string, unknown> | null;
-export declare type GenericConfigObject = Record<string, ConfigValue>;
+export type ConfigValue = string | number | boolean | Record<string, unknown> | null;
+export type GenericConfigObject = Record<string, ConfigValue>;
 /** Set a value in a nested object
  *
  * This will set, for example, sourceObject.foo.bar = value by making copies of

package/lib/repl.d.ts

@@ -1,5 +1,5 @@
 /** Function called when the REPL is closed */
-export declare type ReplCloseFunc = () => void;
+export type ReplCloseFunc = () => void;
 /** Mimic the required elements from a db object */
 interface DBLikeObject {
     /** db object can have a reference to an initialized sequelize instance */

package/lib/util.js

@@ -38,10 +38,10 @@ const trimWordEnd = 3;
  */
 const camelToKebab = (camel) => camel.length === 0
     ? ""
-    : `${camel[0].toUpperCase()}${camel.substr(1)}`
+    : `${camel[0].toUpperCase()}${camel.substring(1)}`
         .replace(/[A-Z][A-Z0-9]+[a-z0-9]/ug, value => value[0]
-        + value.substr(1, value.length - trimWordEnd).toLowerCase()
-        + value.substr(value.length - trimWordStart)).replace(/[A-Z][A-Z]+$/u, value => value[0] + value.substr(1).toLowerCase())
+        + value.substring(1, value.length - trimWordEnd + 1).toLowerCase()
+        + value.substring(value.length - trimWordStart)).replace(/[A-Z][A-Z]+$/u, value => value[0] + value.substring(1).toLowerCase())
         .split(/(?=[A-Z])/u)
         .map(word => word.toLowerCase())
         .join("-");

package/lib/winston.d.ts

@@ -25,7 +25,7 @@ interface ExtendedErrorFields {
     };
     statusCode?: number;
 }
-declare type ExtendedError = Error & ExtendedErrorFields;
+type ExtendedError = Error & ExtendedErrorFields;
 /** Return a string with the full error and stacktrace, including causes */
 export declare const filterError: (error: ExtendedError, collapseStacktrace?: boolean, extraFilter?: Array<RegExp> | RegExp) => string;
 export declare const customFormat: (timestamp?: boolean, collapseStacktrace?: boolean, stacktraceFilter?: Array<RegExp> | RegExp) => Format;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cley_faye/boilerplate",
-  "version": "3.12.1",
+  "version": "3.13.0",
   "description": "Boilerplate code generator for generic projects",
   "repository": {
     "type": "git",
@@ -8,6 +8,7 @@
   },
   "scripts": {
     "prepack": "npm run grunt -- clean build",
+    "check": "tsc --noEmit && eslint .",
     "grunt": "npx grunt --gruntfile Gruntfile.cjs"
   },
   "author": "Gabriel Paul \"Cley Faye\" Risterucci",
@@ -17,25 +18,26 @@
   },
   "homepage": "https://github.com/CleyFaye/boilerplate#readme",
   "devDependencies": {
-    "@keeex/eslint-config": "^1.8.2",
-    "@types/express": "^4.17.14",
+    "@keeex/eslint-config": "^1.9.2",
+    "@types/express": "^4.17.17",
     "@types/grunt": "^0.4.27",
     "@types/http-errors": "^2.0.1",
-    "@types/node": "^18.11.9",
-    "@typescript-eslint/eslint-plugin": "^5.41.0",
-    "@typescript-eslint/parser": "^5.41.0",
-    "eslint": "^8.26.0",
-    "eslint-plugin-import": "^2.26.0",
+    "@types/node": "^18.11.19",
+    "@typescript-eslint/eslint-plugin": "^5.50.0",
+    "@typescript-eslint/parser": "^5.50.0",
+    "eslint": "^8.33.0",
+    "eslint-plugin-deprecation": "^1.3.3",
+    "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-webpack-plugin": "^3.2.0",
     "express-winston": "^4.2.0",
-    "grunt": "^1.5.3",
+    "grunt": "^1.6.1",
     "grunt-banner": "^0.6.0",
     "grunt-contrib-clean": "^2.0.1",
     "grunt-run": "^0.8.1",
     "load-grunt-tasks": "^5.1.0",
     "logform": "^2.4.2",
-    "typescript": "^4.8.4",
+    "typescript": "^4.9.5",
     "winston": "^3.8.2"
   },
   "peerDependencies": {
@@ -55,7 +57,7 @@
     "grunt-contrib-watch": "1.x",
     "grunt-sass": "3.x",
     "grunt-webpack": "5.x",
-    "resolve-typescript-plugin": "2.x",
+    "resolve-typescript-plugin": "^2.0.0",
     "sass": "1.x",
     "ts-loader": "^9.4.1",
     "winston": "3.x"
@@ -110,7 +112,7 @@
       "optional": true
     },
     "resolve-typescript-plugin": {
-      "optional": true
+      "optional": false
     },
     "sass": {
       "optional": true