@cley_faye/boilerplate 3.16.0 → 3.16.1

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,6 +1,6 @@
 {
   "name": "@cley_faye/boilerplate",
-  "version": "3.16.0",
+  "version": "3.16.1",
   "description": "Boilerplate code generator for generic projects",
   "repository": {
     "type": "git",