@cley_faye/boilerplate 3.21.2 → 4.0.1

package/lib/express/logger.js

@@ -1,132 +0,0 @@
-/**
- * @license
- * @preserve
- * MIT License
- *
- * Copyright (c) 2021 Gabriel Paul "Cley Faye" Risterucci
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- *
- */
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerErrorLogger = exports.registerRouteLogger = exports.defaultRouteLoggerConfig = void 0;
-const winston_1 = __importDefault(require("winston"));
-const express_winston_1 = __importDefault(require("express-winston"));
-const winston_js_1 = require("../winston.js");
-const customRouteFormat = (outputTimestamp) => winston_1.default.format.printf((info) => {
-    const meta = info.meta;
-    // Clean the meta object from stuff displayed in the regular message
-    if (meta.res?.statusCode) {
-        delete meta.res.statusCode;
-    }
-    if (meta.res) {
-        if (Object.keys(meta.res).length === 0) {
-            delete meta.res;
-        }
-    }
-    if ("responseTime" in meta) {
-        delete meta.responseTime;
-    }
-    if (meta.req) {
-        if (Object.keys(meta.req).length === 0) {
-            delete meta.req;
-        }
-    }
-    const metaString = JSON.stringify(info.meta);
-    const finalMessage = `${info.message.toString()} ${metaString === "{}" ? "" : metaString}`;
-    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 = (authFromReq) => ({
-    meta: true,
-    requestWhitelist: ["body"],
-    responseWhitelist: [],
-    dynamicMeta: (req) => {
-        const castReq = req;
-        const data = { ...castReq._cleyfayeLogging?.extraLoggingData };
-        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, authFromReq, ignoredRoutes } = logOptions ?? {};
-    let extraConfig;
-    if (typeof route === "boolean") {
-        extraConfig = (0, exports.defaultRouteLoggerConfig)(authFromReq ?? userFromReq);
-    }
-    else {
-        extraConfig = { ...route };
-        const rec = extraConfig;
-        if (rec.winstonInstance) {
-            delete rec.winstonInstance;
-        }
-    }
-    const baseConfig = {
-        meta: true,
-        requestWhitelist: ["body"],
-        bodyWhitelist: [],
-        expressFormat: false,
-        format: customRouteFormat(timestamp),
-        msg: "{{req.method}} {{req.url}} {{res.statusCode}} {{res.responseTime}}ms",
-        ignoredRoutes,
-    };
-    app.use(express_winston_1.default.logger({
-        transports: winston_js_1.transports,
-        ...baseConfig,
-        ...extraConfig,
-    }));
-};
-exports.registerRouteLogger = registerRouteLogger;
-const getExtraFilter = (userExtraFilter) => {
-    const expressRegEx = /node_modules\/express/u;
-    if (!userExtraFilter)
-        return expressRegEx;
-    if (Array.isArray(userExtraFilter))
-        return [expressRegEx, ...userExtraFilter];
-    return [expressRegEx, userExtraFilter];
-};
-const registerErrorLogger = (app, logOptions) => {
-    const { error, logger, timestamp } = logOptions ?? {};
-    const config = typeof error === "boolean"
-        ? {}
-        : error ?? {};
-    const activeTransports = logger ? logger.transports : winston_js_1.transports;
-    app.use(express_winston_1.default.errorLogger({
-        transports: activeTransports,
-        format: (0, winston_js_1.customFormat)(timestamp, config.collapseStacktrace ?? config.collapseNodeModules, getExtraFilter(config.extraFilter)),
-        meta: false,
-    }));
-};
-exports.registerErrorLogger = registerErrorLogger;

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

@@ -1,9 +0,0 @@
-import { NextFunction, Request, Response } from "express";
-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;
-}
-export declare const bodyLogger: (bodyProps?: Array<string>, extraLoggingData?: ExtraLoggingData, options?: ExtraLoggingOptions) => (req: Request, res: Response, next: NextFunction) => void;

package/lib/express/middlewares/bodylogger.js

@@ -1,90 +0,0 @@
-/**
- * @license
- * @preserve
- * MIT License
- *
- * Copyright (c) 2021 Gabriel Paul "Cley Faye" Risterucci
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- *
- */
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.bodyLogger = void 0;
-const setLogInfoInReq = (req, body, extraData) => {
-    const castReq = req;
-    if (body) {
-        if (!castReq._routeWhitelists)
-            castReq._routeWhitelists = {};
-        castReq._routeWhitelists.body = body;
-    }
-    if (extraData) {
-        castReq._cleyfayeLogging = { extraLoggingData: extraData };
-    }
-};
-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;
-        Object.assign(allExtraData, extraLogData);
-        setLogInfoInReq(req, bodyProps, allExtraData);
-    };
-    asyncFunc()
-        .then(() => {
-        next();
-    })
-        .catch((error) => {
-        next(error);
-    });
-};
-exports.bodyLogger = bodyLogger;

package/lib/express/pipelinebuilder.d.ts

@@ -1,115 +0,0 @@
-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 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 type ComplexRouteHandler = express.RequestHandler | express.Router | Array<express.RequestHandler>;
-export interface ComplexRouteDefinition {
-    route: string;
-    handler: ComplexRouteHandler;
-    method?: "get" | "post" | "put" | "options";
-}
-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 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;
-    ignoredRoutes?: Array<string>;
-    /** @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 */
-    noErrorFilter?: boolean;
-}
-export interface PipelineSettings {
-    topLevels?: Array<RouterWithNullDef>;
-    routes?: Array<RouterWithNullDef>;
-    statics?: Array<StaticDefinition>;
-    postStatics?: Array<RouterWithNullDef>;
-    errorHandlers?: Array<express.ErrorRequestHandler>;
-    options?: {
-        log?: LogOptions;
-        middleware?: MiddlewareOptions;
-        defaultErrorHandler?: boolean | DefaultErrorHandlerConfig;
-    };
-}
-export default class PipelineBuilder {
-    private _debugLog?;
-    constructor(debugLog?: LogFunction);
-    private static _addRouterToRouter;
-    private static _addMiddlewareToRouter;
-    /** Register error handlers
-     *
-     * @param router
-     * @param errorHandlers
-     */
-    private static _setErrorHandlers;
-    /** Appropriate call to express.static() */
-    private static _buildStaticHandler;
-    /** See createPipeline() for more info */
-    createPipeline({ topLevels, routes, statics, postStatics, errorHandlers, options, }: PipelineSettings): express.Router;
-    protected internalLog(...args: Array<string | number | Record<string, string>>): void;
-    /** Add generic middlewares to a router
-     *
-     * @param router
-     * @param [middlewareOptions]
-     * @param [middlewareOptions.json]
-     * Process JSON body
-     */
-    private _setGenericMiddlewares;
-    private _addRouteToRouter;
-    /** Register routes
-     *
-     * @param router
-     * @param routes
-     * See routes in createPipeline()
-     */
-    private _setRoutes;
-    /** Use a static definition */
-    private _useComplexStatic;
-    /** Define static resources for the express server
-     *
-     * @param router
-     * @param statics
-     * See createPipeline()
-     */
-    private _setStatics;
-    /** Register pre-route loggers
-     *
-     * @param router
-     * @param [logOptions]
-     * @param [logOptions.route]
-     * Log each route call
-     * @param [logOptions.logger]
-     */
-    private _setRouteLogger;
-    /** Register post-route loggers
-     *
-     * @param {Router} router
-     * @param {object} [logOptions]
-     * @param {bool} [logOptions.error]
-     * Log each error
-     * @param {winstonLogger} [logOptions.logger]
-     */
-    private _setErrorLogger;
-    private _setDefaultErrorHandler;
-}

package/lib/express/pipelinebuilder.js

@@ -1,288 +0,0 @@
-/**
- * @license
- * @preserve
- * MIT License
- *
- * Copyright (c) 2021 Gabriel Paul "Cley Faye" Risterucci
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- *
- */
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const express_1 = __importDefault(require("express"));
-const winston_js_1 = require("../winston.js");
-const logger_js_1 = require("./logger.js");
-const unprocessableentityerror_js_1 = require("./unprocessableentityerror.js");
-const getErrorData = (error) => {
-    const unprocessable = (0, unprocessableentityerror_js_1.get422Fields)(error);
-    if (unprocessable) {
-        return {
-            message: unprocessable.message,
-            extraFields: { fields: unprocessable.fields, errors: unprocessable.errors },
-        };
-    }
-    return error.expose ? { message: error.message } : {};
-};
-const defaultErrorHandler = (errorHandlerConfig) => (err, req, res, next) => {
-    const noErrorFilter = typeof errorHandlerConfig === "boolean"
-        ? false
-        : Boolean(errorHandlerConfig.noErrorFilter);
-    if (!res.headersSent) {
-        if (err.statusCode) {
-            const errorData = getErrorData(err);
-            const accepted = req.accepts([
-                "text",
-                "html",
-                "json",
-            ]);
-            if (accepted === "json") {
-                res.status(err.statusCode).send({
-                    statusCode: err.statusCode,
-                    message: errorData.message,
-                    ...errorData.extraFields,
-                });
-                return;
-            }
-            if (errorData.message) {
-                res.status(err.statusCode).send(errorData.message);
-            }
-            else {
-                res.sendStatus(err.statusCode);
-            }
-            return;
-        }
-        if (!noErrorFilter) {
-            // eslint-disable-next-line @typescript-eslint/no-magic-numbers
-            res.status(500).send("An unexpected error occured");
-            return;
-        }
-    }
-    next(err);
-};
-class PipelineBuilder {
-    constructor(debugLog) {
-        this._debugLog = debugLog;
-    }
-    static _addRouterToRouter(baseRouter, newRouter) {
-        baseRouter.use(newRouter);
-    }
-    static _addMiddlewareToRouter(router, middleware) {
-        router.use(middleware);
-    }
-    /** Register error handlers
-     *
-     * @param router
-     * @param errorHandlers
-     */
-    static _setErrorHandlers(router, errorHandlers) {
-        (errorHandlers ?? []).forEach(errorHandler => {
-            router.use(errorHandler);
-        });
-    }
-    /** Appropriate call to express.static() */
-    static _buildStaticHandler(staticDef) {
-        return typeof staticDef === "string"
-            ? express_1.default.static(staticDef)
-            : express_1.default.static(staticDef.root, staticDef.options);
-    }
-    /** See createPipeline() for more info */
-    createPipeline({ topLevels, routes, statics, postStatics, errorHandlers, options, }) {
-        const { middleware, log, defaultErrorHandler: useDefaultErrorHandler } = options ?? {};
-        this.internalLog("createPipeline()");
-        if (log) {
-            const errorConfig = typeof log.error === "boolean"
-                ? {}
-                : log.error ?? {};
-            (0, winston_js_1.setConfig)({
-                timestamp: log.timestamp ?? false,
-                collapseNodeModules: errorConfig.collapseNodeModules ?? true,
-                collapseStacktrace: errorConfig.collapseStacktrace ?? true,
-            });
-        }
-        const router = express_1.default.Router();
-        this.internalLog("setGenericMiddlewares()");
-        this._setGenericMiddlewares(router, middleware);
-        this.internalLog("add top level routes/middleware");
-        this._setRoutes(router, topLevels);
-        this.internalLog("add logger (route call)");
-        this._setRouteLogger(router, log);
-        this.internalLog("add routes");
-        this._setRoutes(router, routes);
-        this.internalLog("add statics");
-        this._setStatics(router, statics);
-        this.internalLog("add post statics routes");
-        this._setRoutes(router, postStatics);
-        this.internalLog("add logger (errors)");
-        this._setErrorLogger(router, log);
-        this.internalLog("add error handlers");
-        PipelineBuilder._setErrorHandlers(router, errorHandlers);
-        this.internalLog("add default error handlers");
-        this._setDefaultErrorHandler(router, useDefaultErrorHandler);
-        return router;
-    }
-    internalLog(...args) {
-        if (this._debugLog) {
-            this._debugLog(...args);
-        }
-    }
-    /** Add generic middlewares to a router
-     *
-     * @param router
-     * @param [middlewareOptions]
-     * @param [middlewareOptions.json]
-     * Process JSON body
-     */
-    _setGenericMiddlewares(router, middlewareOptions) {
-        const { urlencoded, text, raw, json, } = middlewareOptions ?? {};
-        if (urlencoded) {
-            this.internalLog("express.urlencoded()");
-            const options = urlencoded === true
-                ? { extended: true }
-                : urlencoded;
-            router.use(express_1.default.urlencoded(options));
-        }
-        if (text) {
-            this.internalLog("express.text()");
-            const options = text === true
-                ? undefined
-                : text;
-            router.use(express_1.default.text(options));
-        }
-        if (raw) {
-            this.internalLog("express.raw()");
-            const options = raw === true
-                ? undefined
-                : raw;
-            router.use(express_1.default.raw(options));
-        }
-        if (json) {
-            this.internalLog("express.json()");
-            const options = json === true
-                ? undefined
-                : json;
-            router.use(express_1.default.json(options));
-        }
-    }
-    _addRouteToRouter(router, route) {
-        const method = route.method ?? "get";
-        this.internalLog(`Adding route "${route.route}" [${method}]`);
-        // Simple route definition
-        if (Array.isArray(route.handler)) {
-            // Multiple handlers for same route
-            route.handler.forEach(handler => router[method](route.route, handler));
-        }
-        else {
-            // Simple handler
-            router[method](route.route, route.handler);
-        }
-    }
-    /** Register routes
-     *
-     * @param router
-     * @param routes
-     * See routes in createPipeline()
-     */
-    _setRoutes(router, routes) {
-        (routes ?? []).filter((e) => Boolean(e)).forEach(routeDef => {
-            const asRouter = routeDef;
-            const asRouteDef = routeDef;
-            const asRequestHandler = routeDef;
-            if (asRouter.name === "router") {
-                // Raw router
-                this.internalLog("Adding raw router");
-                PipelineBuilder._addRouterToRouter(router, asRouter);
-            }
-            else if (asRouteDef.route) {
-                // Specific routes
-                this._addRouteToRouter(router, asRouteDef);
-            }
-            else {
-                // Middleware
-                this.internalLog("Adding middleware");
-                PipelineBuilder._addMiddlewareToRouter(router, asRequestHandler);
-            }
-        });
-    }
-    /** Use a static definition */
-    _useComplexStatic(router, staticDef) {
-        const staticHandler = PipelineBuilder._buildStaticHandler(staticDef);
-        if (typeof staticDef === "string") {
-            this.internalLog("Adding statics");
-            router.use(staticHandler);
-        }
-        else if (staticDef.route) {
-            this.internalLog(`Adding statics for route "${staticDef.route}"`);
-            router.use(staticDef.route, staticHandler);
-        }
-        else {
-            this.internalLog("Adding statics");
-            router.use(staticHandler);
-        }
-    }
-    /** Define static resources for the express server
-     *
-     * @param router
-     * @param statics
-     * See createPipeline()
-     */
-    _setStatics(router, statics) {
-        (statics ?? []).forEach(staticDef => this._useComplexStatic(router, staticDef));
-    }
-    /** Register pre-route loggers
-     *
-     * @param router
-     * @param [logOptions]
-     * @param [logOptions.route]
-     * Log each route call
-     * @param [logOptions.logger]
-     */
-    _setRouteLogger(router, logOptions) {
-        const { route } = logOptions ?? {};
-        if (route) {
-            this.internalLog("Adding route logger");
-            (0, logger_js_1.registerRouteLogger)(router, logOptions);
-        }
-    }
-    /** Register post-route loggers
-     *
-     * @param {Router} router
-     * @param {object} [logOptions]
-     * @param {bool} [logOptions.error]
-     * Log each error
-     * @param {winstonLogger} [logOptions.logger]
-     */
-    _setErrorLogger(router, logOptions) {
-        const { error } = logOptions ?? {};
-        if (error) {
-            this.internalLog("Adding error logger");
-            (0, logger_js_1.registerErrorLogger)(router, logOptions);
-        }
-    }
-    _setDefaultErrorHandler(router, defaultErrorHandlerConfig) {
-        if (defaultErrorHandlerConfig) {
-            this.internalLog("Adding default error handler");
-            router.use(defaultErrorHandler(defaultErrorHandlerConfig));
-        }
-    }
-}
-exports.default = PipelineBuilder;

package/lib/express/unprocessableentityerror.d.ts

@@ -1,8 +0,0 @@
-import { ExtendedError } from "../winston.js";
-interface Error422Fields {
-    message: string;
-    fields: Array<string>;
-    errors: Array<unknown>;
-}
-export declare const get422Fields: (error: ExtendedError) => Error422Fields | undefined;
-export {};