@cley_faye/boilerplate 3.16.0 → 3.17.0

package/README.md

@@ -486,6 +486,10 @@ Available config options are:
 - `staticRootDirectories`: optional, name of directories (in the above root directory) to serve as
   static files. Defaults to `["js", "css", "img"]`.
 
+A convenience command is available as "serve_spa" to be called from the command line.
+It is possible to pass it some parameters; run it with `--help` for more informations.
+To use this tool, `minimist` must be installed in addition to express dependencies.
+
 Console logging
 ---------------
 For convenience, a winston logger using console as output is provided:

package/bin/serve_spa.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+// eslint-disable-next-line import/no-unresolved
+import("../lib/bin/serve_spa.js");

package/lib/bin/serve_spa.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/bin/serve_spa.js

@@ -0,0 +1,113 @@
+/**
+ * @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 __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path = __importStar(require("node:path"));
+const express_1 = __importDefault(require("express"));
+const minimist_1 = __importDefault(require("minimist"));
+const singlepageapp_js_1 = require("../express/middlewares/singlepageapp.js");
+const express_js_1 = require("../express.js");
+const winston_js_1 = require("../winston.js");
+const ARGV_START_OFFSET = 2;
+const { port, root, index, help, static: staticDirs } = (0, minimist_1.default)(process.argv.slice(ARGV_START_OFFSET));
+const DEFAULT_PORT = 3000;
+const DEFAULT_PATH = path.join("dist", "webapp");
+const DEFAULT_INDEX = "index.html";
+const DEFAULT_STATIC = ["js", "css", "img"];
+if (help) {
+    winston_js_1.consoleLogger.info(`
+Usage:
+
+serve_spa \\
+  [--port=${DEFAULT_PORT}] \\
+  [--root=${DEFAULT_PATH}] \\
+  [--index=${DEFAULT_INDEX}] \\
+  [--static=js…] \\
+  [--help]
+
+The --static argument can be repeated to add more directories to it.
+It defaults to ${JSON.stringify(DEFAULT_STATIC)}.
+`.trim());
+    // eslint-disable-next-line no-process-exit
+    process.exit(0);
+}
+const getPort = () => port ?? DEFAULT_PORT;
+const getStatic = () => {
+    if (!staticDirs)
+        return;
+    return Array.isArray(staticDirs) ? staticDirs : [staticDirs];
+};
+const app = (0, express_1.default)();
+app.use((0, express_js_1.createPipeline)({
+    routes: (0, singlepageapp_js_1.singlePageApp)({
+        rootDir: root ?? "dist/webapp",
+        htmlFile: index,
+        staticRootDirectories: getStatic(),
+    }),
+    options: {
+        defaultErrorHandler: true,
+        log: {
+            route: true,
+            error: true,
+            logger: winston_js_1.consoleLogger,
+        },
+    },
+}));
+(0, express_js_1.appStart)({
+    app,
+    port: getPort(),
+    logger: winston_js_1.consoleLogger,
+}).then(({ port: activePort }) => {
+    winston_js_1.consoleLogger.info(`SPA served on port ${activePort}`);
+})
+    .catch(winston_js_1.consoleLogger.error);

package/lib/express/middlewares/singlepageapp.js

@@ -80,7 +80,10 @@ const singlePageApp = (config) => {
         for (const candidates of staticDirs)
             if (req.url.startsWith(candidates))
                 return next();
-        res.sendFile(htmlFile, { root: rootDir }, (err) => next(err));
+        res.sendFile(htmlFile, { root: rootDir }, (err) => {
+            if (err)
+                return next(err);
+        });
     };
     const staticRoute = express_1.default.static(rootDir);
     return [appRoute, staticRoute];

package/lib/express/pipelinebuilder.js

@@ -32,15 +32,24 @@ 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 message = err.expose
-                ? err.message
-                : undefined;
+            const errorData = getErrorData(err);
             const accepted = req.accepts([
                 "text",
                 "html",
@@ -49,12 +58,13 @@ const defaultErrorHandler = (errorHandlerConfig) => (err, req, res, next) => {
             if (accepted === "json") {
                 res.status(err.statusCode).send({
                     statusCode: err.statusCode,
-                    message,
+                    message: errorData.message,
+                    ...errorData.extraFields,
                 });
                 return;
             }
-            if (message) {
-                res.status(err.statusCode).send(message);
+            if (errorData.message) {
+                res.status(err.statusCode).send(errorData.message);
             }
             else {
                 res.sendStatus(err.statusCode);

package/lib/express/unprocessableentityerror.d.ts

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

package/lib/express/unprocessableentityerror.js

@@ -0,0 +1,57 @@
+/**
+ * @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/winston.d.ts

@@ -23,9 +23,11 @@ interface ExtendedErrorFields {
     request?: {
         _currentUrl?: string;
     };
+    fields?: Set<string>;
     statusCode?: number;
+    expose?: boolean;
 }
-type ExtendedError = Error & ExtendedErrorFields;
+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;

package/lib/winston.js

@@ -31,6 +31,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.consoleLogger = exports.transports = exports.setConfig = exports.customFormat = exports.filterError = exports.prefixOutput = exports.filterStacktrace = void 0;
 const winston_1 = __importDefault(require("winston"));
+const unprocessableentityerror_js_1 = require("./express/unprocessableentityerror.js");
 const LOG_LEVEL_PADDING_SIZE = 10;
 const stackFilterRegex = /(?:at process|at runMicrotasks)/u;
 const isFiltered = (line, extraFilter) => {
@@ -150,9 +151,20 @@ const getCause = (error) => {
         return new Error("Unknown cause");
     }
 };
+/** Handle 422
+ *
+ * If return a string, do not process the error normally.
+ */
+const process422Error = (error) => {
+    const errorInfo = (0, unprocessableentityerror_js_1.get422Fields)(error);
+    return errorInfo?.message;
+};
 /** Return a string with the full error and stacktrace, including causes */
 const filterError = (error, collapseStacktrace = true, extraFilter) => {
     const resultRows = [];
+    const unprocessableCheck = process422Error(error);
+    if (unprocessableCheck)
+        return unprocessableCheck;
     let cursor = error;
     let indentLevel = 0;
     while (cursor) {

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@cley_faye/boilerplate",
-  "version": "3.16.0",
+  "version": "3.17.0",
   "description": "Boilerplate code generator for generic projects",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/CleyFaye/boilerplate.git"
   },
+  "bin": {
+    "serve_spa": "bin/serve_spa.js"
+  },
   "scripts": {
     "prepack": "npm run grunt -- clean build",
     "check": "tsc --noEmit && eslint .",
@@ -22,6 +25,7 @@
     "@types/express": "^4.17.17",
     "@types/grunt": "^0.4.27",
     "@types/http-errors": "^2.0.1",
+    "@types/minimist": "^1.2.2",
     "@types/node": "^18.14.2",
     "@typescript-eslint/eslint-plugin": "^5.53.0",
     "@typescript-eslint/parser": "^5.53.0",
@@ -58,6 +62,7 @@
     "grunt-contrib-watch": "1.x",
     "grunt-sass": "3.x",
     "grunt-webpack": "5.x",
+    "minimist": "^1.2.8",
     "sass": "1.x",
     "ts-loader": "^9.4.1",
     "winston": "3.x"
@@ -111,6 +116,9 @@
     "grunt-webpack": {
       "optional": true
     },
+    "minimist": {
+      "optional": true
+    },
     "sass": {
       "optional": true
     },