@cley_faye/boilerplate 3.21.2 → 4.0.1

package/lib/express/unprocessableentityerror.js

@@ -1,57 +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.get422Fields = void 0;
-const UNPROCESSABLE_ENTITY = 422;
-const get422Fields = (error) => {
-    const { statusCode, cause, fields } = error;
-    if (statusCode !== UNPROCESSABLE_ENTITY
-        || !cause
-        || !Array.isArray(cause)
-        || !fields
-        || !Array.isArray(fields)) {
-        return;
-    }
-    let fieldsStr;
-    try {
-        fieldsStr = JSON.stringify(fields);
-    }
-    catch {
-        fieldsStr = "<error>";
-    }
-    let errorsStr;
-    try {
-        errorsStr = JSON.stringify(cause);
-    }
-    catch {
-        errorsStr = "<error>";
-    }
-    const message = `${error.message}: fields=${fieldsStr}, errors=${errorsStr}`;
-    return { message, fields, errors: cause };
-};
-exports.get422Fields = get422Fields;

package/lib/express.d.ts

@@ -1,158 +0,0 @@
-/// <reference types="express-serve-static-core" />
-/// <reference types="node" />
-import { Server } from "net";
-import express from "express";
-import winston from "winston";
-import { PipelineSettings, LogFunction } from "./express/pipelinebuilder.js";
-/** Create the full processing pipeline for an Express server
- *
- * This function creates a pipeline this way:
- *  - Pass generic middlewares (see options)
- *  - Pass custom top-level middlewares
- *  - Pass logging middleware (see options)
- *  - Pass routes
- *  - Pass error logging middleware (see options)
- *  - Pass error handlers
- *  - Fallback to a default error handler (see below)
- *
- * The default error handler is a layer above the express default error
- * handler.
- * If it is reached, it will check if the error object looks like an
- * http-errors exception, and if that's the case, send the error code and the
- * message (if applicable).
- * If the request accepts json, a json object with the error is returned.
- * Otherwise text is returned.
- *
- * For convenience, providing timestamp and collapseNodeModules here will automatically
- * update the basic consoleLogger configuration.
- *
- * @param settings
- *
- * @param [settings.topLevels]
- * List top-level middlewares. See routes.
- *
- * @param [settings.routes]
- * List routes and routers.
- * For each router and function, a simple "use()" call is used.
- * If an object is provided, it must have two properties:
- *  - route: the actual route to listen to
- *  - handler: either a function, a router, or an array of functions that will
- *  be called in sequence on this request.
- *  - method: the method ("get", "post", "put", "options"). If missing,
- *    default to "get".
- *
- * @param [settings.statics]
- * List of directory to serve as static content.
- * Can be either a string (the path) or an object with the following
- * properties:
- *  - root: the root in the filesystem for this static provider
- *  - options: (optional) the options to pass to static()
- *  - route: (optional) the route where the static resources will be served
- *
- * @param [settings.postStatics]
- * Register routes handled after statics. See routes.
- *
- * @param [settings.errorHandlers]
- * Process errors. Must be function with four parameters.
- *
- * @param [settings.options]
- * @param [settings.options.log]
- * @param [settings.options.log.route]
- * Log each route. Can be an object with all properties expected from
- * winston-express.logger()
- *
- * @param [settings.options.log.error]
- * Log error content. Can be either a boolean or an object with the
- * "collapseNodeModules" property. The error log will then display a truncated
- * stacktrace where lines containing node_modules are removed.
- *
- * @param [settings.options.log.timestamp]
- * Log timestamps on each lines
- *
- * @param [settings.options.log.logger]
- * An existing winston logger to use. Only the transport will be used.
- *
- * @param [settings.options.middleware]
- * @param [settings.options.middleware.urlencoded]
- * Parse URL encoded requests. Can be true or settings for urlencoded().
- * Default to handling application/x-www-form-urlencoded.
- *
- * @param [settings.options.middleware.text]
- * Parse raw text body requests. Can be true or settings for text()
- * Default to handling text/plain
- *
- * @param [settings.options.middleware.raw]
- * Parse raw body requests into an arraybuffer. Can be true or settings for
- * raw()
- * Default to handling application/octet-stream
- *
- * @param [settings.options.middleware.json]
- * Parse JSON body requests. Can be true or settings for json()
- * Default to handling application/json
- *
- * @param [settings.options.defaultErrorHandler]
- * Setup the default error handler. Defaults to false.
- *
- * @param [debugLog]
- * Function to log debug informations
- *
- * @return
- * The returned object can be used
- */
-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>) => void;
-/**
- * Function to call when the server stops.
- *
- * This is usually triggered by a SIGTERM.
- *
- * If the function returns "true", it prevent the process from stopping.
- * Otherwise `process.exit()` is called.
- */
-type ShutdownFunction = () => Promise<boolean | undefined> | boolean | undefined;
-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?: ShutdownFunction;
-    logger?: winston.Logger;
-    noReady?: boolean;
-}
-export interface StartResult {
-    port: number;
-    server: Server;
-}
-/** Start the server and register signal for automatic closing.
- *
- * @param app
- * @param [allowNonLocal]
- * Allow requests from outside of localhost
- *
- * @param [port]
- * Port to listen from. Default to a random available port.
- *
- * @param [shutdownFunction]
- * Function to call after the server is shutdown (all connection closed)
- *
- * @param [logger]
- *
- * @return
- * @property port
- * The port the server is listening on
- *
- * @property server
- */
-export declare const appStart: ({ app, allowNonLocal, listenInterface, port, shutdownFunction, logger, noReady, }: StartDefinition) => Promise<StartResult>;
-export {};

package/lib/express.js

@@ -1,218 +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.appStart = exports.setViewEngine = exports.createPipeline = void 0;
-const autoclose_js_1 = require("./express/autoclose.js");
-const pipelinebuilder_js_1 = __importDefault(require("./express/pipelinebuilder.js"));
-/** Create the full processing pipeline for an Express server
- *
- * This function creates a pipeline this way:
- *  - Pass generic middlewares (see options)
- *  - Pass custom top-level middlewares
- *  - Pass logging middleware (see options)
- *  - Pass routes
- *  - Pass error logging middleware (see options)
- *  - Pass error handlers
- *  - Fallback to a default error handler (see below)
- *
- * The default error handler is a layer above the express default error
- * handler.
- * If it is reached, it will check if the error object looks like an
- * http-errors exception, and if that's the case, send the error code and the
- * message (if applicable).
- * If the request accepts json, a json object with the error is returned.
- * Otherwise text is returned.
- *
- * For convenience, providing timestamp and collapseNodeModules here will automatically
- * update the basic consoleLogger configuration.
- *
- * @param settings
- *
- * @param [settings.topLevels]
- * List top-level middlewares. See routes.
- *
- * @param [settings.routes]
- * List routes and routers.
- * For each router and function, a simple "use()" call is used.
- * If an object is provided, it must have two properties:
- *  - route: the actual route to listen to
- *  - handler: either a function, a router, or an array of functions that will
- *  be called in sequence on this request.
- *  - method: the method ("get", "post", "put", "options"). If missing,
- *    default to "get".
- *
- * @param [settings.statics]
- * List of directory to serve as static content.
- * Can be either a string (the path) or an object with the following
- * properties:
- *  - root: the root in the filesystem for this static provider
- *  - options: (optional) the options to pass to static()
- *  - route: (optional) the route where the static resources will be served
- *
- * @param [settings.postStatics]
- * Register routes handled after statics. See routes.
- *
- * @param [settings.errorHandlers]
- * Process errors. Must be function with four parameters.
- *
- * @param [settings.options]
- * @param [settings.options.log]
- * @param [settings.options.log.route]
- * Log each route. Can be an object with all properties expected from
- * winston-express.logger()
- *
- * @param [settings.options.log.error]
- * Log error content. Can be either a boolean or an object with the
- * "collapseNodeModules" property. The error log will then display a truncated
- * stacktrace where lines containing node_modules are removed.
- *
- * @param [settings.options.log.timestamp]
- * Log timestamps on each lines
- *
- * @param [settings.options.log.logger]
- * An existing winston logger to use. Only the transport will be used.
- *
- * @param [settings.options.middleware]
- * @param [settings.options.middleware.urlencoded]
- * Parse URL encoded requests. Can be true or settings for urlencoded().
- * Default to handling application/x-www-form-urlencoded.
- *
- * @param [settings.options.middleware.text]
- * Parse raw text body requests. Can be true or settings for text()
- * Default to handling text/plain
- *
- * @param [settings.options.middleware.raw]
- * Parse raw body requests into an arraybuffer. Can be true or settings for
- * raw()
- * Default to handling application/octet-stream
- *
- * @param [settings.options.middleware.json]
- * Parse JSON body requests. Can be true or settings for json()
- * Default to handling application/json
- *
- * @param [settings.options.defaultErrorHandler]
- * Setup the default error handler. Defaults to false.
- *
- * @param [debugLog]
- * Function to log debug informations
- *
- * @return
- * The returned object can be used
- */
-const createPipeline = (settings, debugLog) => {
-    if (debugLog) {
-        debugLog("Creating PipelineBuilder");
-    }
-    const builder = new pipelinebuilder_js_1.default(debugLog);
-    return builder.createPipeline(settings);
-};
-exports.createPipeline = createPipeline;
-/**
- * Configure the views rendering engine for an ExpressJS App
- */
-const setViewEngine = (app, viewEngine, viewsDirectory, extraLocals) => {
-    app.set("views", viewsDirectory);
-    app.set("view engine", viewEngine);
-    if (extraLocals) {
-        app.locals = {
-            ...app.locals,
-            ...extraLocals,
-        };
-    }
-};
-exports.setViewEngine = setViewEngine;
-const handleShutdown = (logger, shutdownFunction) => () => {
-    const fn = async () => {
-        const noExit = shutdownFunction ? Boolean(await shutdownFunction()) : false;
-        if (noExit)
-            return;
-        // We *want* to exit on server shutdown
-        // eslint-disable-next-line no-process-exit
-        process.exit();
-    };
-    fn().catch(err => {
-        logger?.error(err);
-    });
-};
-/** Start the server and register signal for automatic closing.
- *
- * @param app
- * @param [allowNonLocal]
- * Allow requests from outside of localhost
- *
- * @param [port]
- * Port to listen from. Default to a random available port.
- *
- * @param [shutdownFunction]
- * Function to call after the server is shutdown (all connection closed)
- *
- * @param [logger]
- *
- * @return
- * @property port
- * The port the server is listening on
- *
- * @property server
- */
-const appStart = ({ app, allowNonLocal, listenInterface, port, shutdownFunction, logger, noReady, }) => new Promise(resolve => {
-    let server = null;
-    const readyCallback = () => {
-        if (server === null) {
-            throw new Error("Server reference can not be null");
-        }
-        const effectivePort = server.address().port;
-        if (logger) {
-            logger.info(`Listening on port ${effectivePort} (PID: ${process.pid})`);
-        }
-        (0, autoclose_js_1.setRef)(server);
-        (0, autoclose_js_1.setSignalHandler)();
-        resolve({
-            port: effectivePort,
-            server,
-        });
-        if (!noReady && process.send)
-            process.send("ready");
-    };
-    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);
-    }
-    server.on("close", handleShutdown(logger, shutdownFunction));
-});
-exports.appStart = appStart;

package/lib/repl.d.ts

@@ -1,27 +0,0 @@
-/** Function called when the REPL is closed */
-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 */
-    sequelize?: {
-        /** Sequelize instance should have a close() method */
-        close?: () => void;
-    };
-}
-interface ReplArgs {
-    /** Display a service name in the prompt */
-    serviceName: string;
-    /**
-     * A DB object. If it exposes a db.sequelize.close() function, it will be called when the REPL is
-     * closed.
-     */
-    db?: DBLikeObject;
-    srv?: Record<string, unknown>;
-    /** Extra properties to attach to the REPL context */
-    extraContext?: Record<string, unknown>;
-    onClose?: ReplCloseFunc;
-    historyFile?: string;
-}
-/** Start the REPL prompt */
-export declare const startRepl: ({ serviceName, db, srv, extraContext, onClose, historyFile, }: ReplArgs) => void;
-export {};

package/lib/repl.js

@@ -1,68 +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.startRepl = void 0;
-const repl_1 = __importDefault(require("repl"));
-const setupContext = (r, db, srv, extraContext) => {
-    const doContextSetup = () => {
-        Object.assign(r.context, {
-            ...extraContext,
-            db,
-            srv,
-        });
-    };
-    doContextSetup();
-    r.on("reset", doContextSetup);
-};
-/** Configure action when the REPL is closed */
-const setupClose = (r, db, onClose) => {
-    if (!db && !onClose)
-        return;
-    r.on("exit", () => {
-        if (db?.sequelize?.close) {
-            db.sequelize.close();
-        }
-        if (onClose) {
-            onClose();
-        }
-    });
-};
-/** Start the REPL prompt */
-const startRepl = ({ serviceName = "", db, srv, extraContext, onClose, historyFile = ".node_repl_history", }) => {
-    const r = repl_1.default.start({
-        prompt: `${serviceName}> `,
-        breakEvalOnSigint: true,
-    });
-    setupContext(r, db, srv, extraContext);
-    setupClose(r, db, onClose);
-    r.setupHistory(historyFile, () => { });
-};
-exports.startRepl = startRepl;

package/lib/winston.d.ts

@@ -1,38 +0,0 @@
-import winston from "winston";
-import { Format } from "logform";
-/**
- * Collapse useless lines in stacktrace
- */
-export declare const filterStacktrace: (message: string, extraFilter?: Array<RegExp> | RegExp) => Generator<string>;
-/**
- * Prefix all lines with the level and the timestamp if needed
- */
-export declare const prefixOutput: (level: string, message: string, timestamp: boolean | undefined) => string;
-export interface LogConfig {
-    timestamp: boolean;
-    /** @deprecated Use collapseStacktrace instead */
-    collapseNodeModules: boolean;
-    collapseStacktrace: boolean;
-    stacktraceFilter?: Array<RegExp> | RegExp;
-}
-interface ExtendedErrorFields {
-    cause?: unknown;
-    response?: {
-        data?: string | Record<string, unknown>;
-    };
-    request?: {
-        _currentUrl?: string;
-    };
-    fields?: Set<string>;
-    statusCode?: number;
-    expose?: boolean;
-}
-export 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;
-/** Edit the configuration applied to consoleLogger */
-export declare const setConfig: (config: LogConfig) => void;
-export declare const transports: winston.transports.ConsoleTransportInstance[];
-export declare const consoleLogger: winston.Logger;
-export {};