@expressots/core 2.15.0 → 2.16.0

package/lib/CHANGELOG.md

@@ -1,5 +1,31 @@
 
 
+## [2.16.0](https://github.com/expressots/expressots/compare/2.15.0...2.16.0) (2024-08-08)
+
+
+### Features
+
+* add stack trace option on defaultErrorHandler middleware ([c9005ed](https://github.com/expressots/expressots/commit/c9005ed4e28bd76f7622f1bd006d90b18e8b0cf6))
+* add urlEncodedParser default middleware ([ec44767](https://github.com/expressots/expressots/commit/ec44767e41d8a1a208bb2be1120bb13a97942b20))
+* bump release-it from 17.5.0 to 17.6.0 ([bbdc3c8](https://github.com/expressots/expressots/commit/bbdc3c8ad692775f96f26ba3da952f38441aa58e))
+
+
+### Bug Fixes
+
+* remove express dependency and middlewares.spec ([b538cce](https://github.com/expressots/expressots/commit/b538cce0a9b61e43988d3190973dd79993da833b))
+
+
+### Code Refactoring
+
+* adjust command dev, build, prod ([c819625](https://github.com/expressots/expressots/commit/c819625327a3e9632d418eed0e26af7fa80dcdcc))
+* remove opinionated template example ([bca45ac](https://github.com/expressots/expressots/commit/bca45ac19e4415452e6194468d54a6f34ec5c5d7))
+
+
+### Tests
+
+* ignore middleware service, utils ([6c3e6f7](https://github.com/expressots/expressots/commit/6c3e6f7af7c656ec15e5a5ced23af05eef8a0872))
+* ignore spec on coverage & better comments in app-factory ([698053d](https://github.com/expressots/expressots/commit/698053deeb538fdfdff6ed4a75fd616052df4f58))
+
 ## [2.15.0](https://github.com/expressots/expressots/compare/2.14.1...2.15.0) (2024-07-17)
 
 

package/lib/cjs/application/application-factory.js

@@ -18,8 +18,8 @@ function isWebServerConstructor(input) {
 class AppFactory {
     /**
      * Create an instance of a web server.
-     * @param container - InversifyJS container to resolve dependencies.
-     * @param webServerType - Constructor of a class that implements IWebServer, or array of middlewares.
+     * @param container - Dependency injection container.
+     * @param webServerType - Constructor of a class that implements IWebServer.
      * @returns A promise that resolves to an instance of IWebServer.
      */
     static async create(container, webServerType) {

package/lib/cjs/error/error-handler-middleware.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const app_error_1 = require("./app-error");
 const status_code_1 = require("./status-code");
+const utils_1 = require("./utils");
 /**
  * errorHandler is a custom Express error-handling middleware function.
  * It logs the error, sets the status code, and sends a JSON response containing the status code and error message.
@@ -9,20 +10,30 @@ const status_code_1 = require("./status-code");
  * @param req - The Express request object.
  * @param res - The Express response object.
  * @param next - The Express next function for passing control to the next middleware function.
+ * @param showStackTrace - A boolean value indicating whether to show the stack trace in the response.
  */
 function defaultErrorHandler(error, req, res, 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-next) {
-    if (error instanceof app_error_1.AppError) {
-        res
-            .status(error.statusCode)
-            .json({ statusCode: error.statusCode, error: error.message });
+next, showStackTrace = false) {
+    try {
+        if (error instanceof app_error_1.AppError) {
+            res.status(error.statusCode).json({
+                statusCode: error.statusCode,
+                error: error.message,
+            });
+        }
+        else {
+            res.status(status_code_1.StatusCode.InternalServerError).json({
+                statusCode: status_code_1.StatusCode.InternalServerError,
+                error: "An unexpected error occurred.",
+            });
+        }
+        if (showStackTrace && error.stack) {
+            (0, utils_1.beautifyStackTrace)(error.stack);
+        }
     }
-    else {
-        res.status(status_code_1.StatusCode.InternalServerError).json({
-            statusCode: status_code_1.StatusCode.InternalServerError,
-            error: "An unexpected error occurred.",
-        });
+    catch (error) {
+        next(error);
     }
 }
 exports.default = defaultErrorHandler;

package/lib/cjs/error/utils.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.beautifyStackTrace = beautifyStackTrace;
+const chalk_1 = __importDefault(require("chalk"));
+function beautifyStackTrace(stack) {
+    if (!stack)
+        return;
+    const lines = stack.split("\n");
+    const errorMessage = lines.shift()?.trim();
+    const maxOriginLength = "[External Library]".length;
+    const stackLines = lines
+        .filter((line) => line.trim().startsWith("at"))
+        .map((line) => line.trim())
+        .map((line) => {
+        const isExternalLib = line.includes("node_modules");
+        const filePathMatch = line.match(/\((.*):(\d+):(\d+)\)/);
+        const filePath = filePathMatch
+            ? `${filePathMatch[1]}:${filePathMatch[2]}:${filePathMatch[3]}`
+            : "";
+        const stackMessage = line.replace(/\(.*\)/, "").trim();
+        return {
+            origin: isExternalLib
+                ? chalk_1.default.gray("[External Library]").padEnd(maxOriginLength)
+                : chalk_1.default.gray("[Application]     ").padEnd(maxOriginLength),
+            stackMessage: chalk_1.default.green(stackMessage),
+            filePath: chalk_1.default.white(filePath),
+        };
+    });
+    if (stackLines.length > 0) {
+        console.log(chalk_1.default.red.bold(`Error Originated From: ${chalk_1.default.bold.white(stackLines[0]?.filePath || "unknown")}`));
+    }
+    console.log(chalk_1.default.red.bold(errorMessage));
+    console.log(chalk_1.default.blue.bold("\nStack Trace:\n"));
+    stackLines.forEach(({ origin, stackMessage, filePath }) => {
+        console.log(`${origin} | ${stackMessage} | ${filePath}`);
+    });
+    return "";
+}

package/lib/cjs/middleware/interfaces/url-encoded.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/middleware/middleware-resolver.js

@@ -25,6 +25,7 @@ class MiddlewareResolver {
             rateLimit: "express-rate-limit",
             multer: "multer",
             session: "express-session",
+            urlencoded: "urlencodedParser",
             // Add other middlewares
         };
         this.logger = new logger_provider_1.Logger();

package/lib/cjs/middleware/middleware-service.js

@@ -93,6 +93,24 @@ let Middleware = class Middleware {
             return false;
         });
     }
+    /**
+     * Adds a URL Encoded Parser middleware to the middleware collection.
+     * The URL Encoded Parser is responsible for parsing the URL-encoded data in the incoming request bodies.
+     *
+     * @param options - Optional configuration options for the URL Encoded Parser.
+     */
+    addUrlEncodedParser(options) {
+        const middlewareExist = this.middlewareExists("urlencodedParser");
+        if (middlewareExist) {
+            this.logger.warn(`[urlencodedParser] already exists. Skipping...`, "configure-service");
+        }
+        else {
+            this.middlewarePipeline.push({
+                timestamp: new Date(),
+                middleware: express_1.default.urlencoded(options),
+            });
+        }
+    }
     addRateLimiter(options) {
         const middleware = (0, middleware_resolver_1.middlewareResolver)("rateLimit", options);
         const middlewareExist = this.middlewareExists("rateLimit");
@@ -257,11 +275,16 @@ let Middleware = class Middleware {
     /**
      * Configures the error handling middleware for the application.
      *
-     * @param errorHandling - The Express error handler function that takes care of processing errors and formulating the response.
+     * @param options - The object containing the configuration options for the error handler middleware.
+     * @param errorHandler - The Express error handler function that takes care of processing errors and formulating the response.
+     * @param showStackTrace - A boolean value indicating whether to show the stack trace in the response.
      */
-    setErrorHandler(errorHandling) {
+    setErrorHandler(options = {}) {
+        const { errorHandler: errorHandling, showStackTrace } = options;
         if (!errorHandling) {
-            this.errorHandler = error_handler_middleware_1.default;
+            this.errorHandler = (error, req, res, next) => {
+                (0, error_handler_middleware_1.default)(error, req, res, next, showStackTrace);
+            };
         }
         else {
             this.errorHandler = errorHandling;

package/lib/cjs/types/application/application-factory.d.ts

@@ -10,8 +10,8 @@ declare class AppFactory {
     private static logger;
     /**
      * Create an instance of a web server.
-     * @param container - InversifyJS container to resolve dependencies.
-     * @param webServerType - Constructor of a class that implements IWebServer, or array of middlewares.
+     * @param container - Dependency injection container.
+     * @param webServerType - Constructor of a class that implements IWebServer.
      * @returns A promise that resolves to an instance of IWebServer.
      */
     static create<T extends IWebServer>(container: Container, webServerType: IWebServerConstructor<T>): Promise<IWebServerPublic>;

package/lib/cjs/types/error/error-handler-middleware.d.ts

@@ -6,6 +6,7 @@ import { NextFunction, Request, Response } from "express";
  * @param req - The Express request object.
  * @param res - The Express response object.
  * @param next - The Express next function for passing control to the next middleware function.
+ * @param showStackTrace - A boolean value indicating whether to show the stack trace in the response.
  */
-declare function defaultErrorHandler(error: Error, req: Request, res: Response, next: NextFunction): void;
+declare function defaultErrorHandler(error: Error, req: Request, res: Response, next: NextFunction, showStackTrace?: boolean): void;
 export default defaultErrorHandler;

package/lib/cjs/types/error/utils.d.ts

@@ -0,0 +1 @@
+export declare function beautifyStackTrace(stack: string): string;

package/lib/cjs/types/middleware/index.d.ts

@@ -1,4 +1,4 @@
-export { IMiddleware, Middleware, ExpressHandler, ExpressoMiddleware, MiddlewareOptions, } from "./middleware-service";
+export { IMiddleware, Middleware, ExpressHandler, ExpressoMiddleware, MiddlewareOptions, ErrorHandlerOptions, } from "./middleware-service";
 export { OptionsJson } from "./interfaces/body-parser.interface";
 export { CorsOptions } from "./interfaces/cors.interface";
 export { CompressionOptions } from "./interfaces/compression.interface";
@@ -10,4 +10,5 @@ export { CookieParserOptions } from "./interfaces/cookie-parser.interface";
 export { ServeFaviconOptions } from "./interfaces/serve-favicon.interface";
 export { RateLimitOptions } from "./interfaces/express-rate-limit.interface";
 export { multer } from "./interfaces/multer.interface";
+export { OptionsUrlencoded } from "./interfaces/url-encoded.interface";
 export * as IMorgan from "./interfaces/morgan.interface";

package/lib/cjs/types/middleware/interfaces/url-encoded.interface.d.ts

@@ -0,0 +1,37 @@
+import * as http from "http";
+interface Options {
+    /** When set to true, then deflated (compressed) bodies will be inflated; when false, deflated bodies are rejected. Defaults to true. */
+    inflate?: boolean | undefined;
+    /**
+     * Controls the maximum request body size. If this is a number,
+     * then the value specifies the number of bytes; if it is a string,
+     * the value is passed to the bytes library for parsing. Defaults to '100kb'.
+     */
+    limit?: number | string | undefined;
+    /**
+     * The type option is used to determine what media type the middleware will parse
+     */
+    type?: string | Array<string> | ((req: http.IncomingMessage) => any) | undefined;
+    /**
+     * The verify option, if supplied, is called as verify(req, res, buf, encoding),
+     * where buf is a Buffer of the raw request body and encoding is the encoding of the request.
+     */
+    verify?(req: http.IncomingMessage, res: http.ServerResponse, buf: Buffer, encoding: string): void;
+}
+/**
+ * These are the options available to urlencodedParser.
+ */
+export interface OptionsUrlencoded extends Options {
+    /**
+     * The extended option allows to choose between parsing the URL-encoded data
+     * with the querystring library (when `false`) or the qs library (when `true`).
+     */
+    extended?: boolean | undefined;
+    /**
+     * The parameterLimit option controls the maximum number of parameters
+     * that are allowed in the URL-encoded data. If a request contains more parameters than this value,
+     * a 413 will be returned to the client. Defaults to 1000.
+     */
+    parameterLimit?: number | undefined;
+}
+export {};

package/lib/cjs/types/middleware/middleware-service.d.ts

@@ -11,6 +11,7 @@ import { RateLimitOptions } from "./interfaces/express-rate-limit.interface";
 import { OptionsHelmet } from "./interfaces/helmet.interface";
 import { multer } from "./interfaces/multer.interface";
 import { SessionOptions } from "./interfaces/express-session.interface";
+import { OptionsUrlencoded } from "./interfaces/url-encoded.interface";
 /**
  * ExpressHandler Type
  *
@@ -66,11 +67,29 @@ interface MiddlewarePipeline {
     timestamp: Date;
     middleware: ExpressHandler | MiddlewareConfig | IExpressoMiddleware;
 }
+/**
+ * ErrorHandlerOptions Interface
+ *
+ * The ErrorHandlerOptions interface specifies the configuration options for the error handler middleware.
+ * @param errorHandler: An Express error handler function that takes care of processing errors and formulating the response.
+ * @param showStackTrace: A boolean value indicating whether to include the stack trace in the error response. The default value is false.
+ */
+export interface ErrorHandlerOptions {
+    errorHandler?: ExpressHandler;
+    showStackTrace?: boolean;
+}
 /**
  * Interface for configuring and managing middlewares in the application.
  * Provides methods to be added automatically in the application without the need to import packages.
  */
 interface IMiddleware {
+    /**
+     * Adds a URL Encoded Parser middleware to the middleware collection.
+     * The URL Encoded Parser is responsible for parsing the URL-encoded data in the incoming request bodies.
+     *
+     * @param options - Optional configuration options for the URL Encoded Parser.
+     */
+    addUrlEncodedParser(options?: OptionsUrlencoded): void;
     /**
      * Adds a Rate Limit middleware to the middleware collection.
      * The rate limiter is responsible for adding dynamic rate limit and request throttling to the application.
@@ -135,9 +154,11 @@ interface IMiddleware {
     /**
      * Configures the error handling middleware for the application.
      *
-     * @param errorHandling - The Express error handler function that takes care of processing errors and formulating the response.
+     * @param options - The object containing the configuration options for the error handler middleware.
+     * @param errorHandler - The Express error handler function that takes care of processing errors and formulating the response.
+     * @param showStackTrace - A boolean value indicating whether to show the stack trace in the response.
      */
-    setErrorHandler(errorHandling?: ExpressHandler): void;
+    setErrorHandler(options?: ErrorHandlerOptions): void;
     /**
      * Adds a middleware to serve static files from the specified root directory.
      * Allows the application to serve files like images, CSS, JavaScript, etc.
@@ -225,6 +246,13 @@ declare class Middleware implements IMiddleware {
      * @returns A boolean value indicating whether the middleware exists or not.
      */
     private middlewareExists;
+    /**
+     * Adds a URL Encoded Parser middleware to the middleware collection.
+     * The URL Encoded Parser is responsible for parsing the URL-encoded data in the incoming request bodies.
+     *
+     * @param options - Optional configuration options for the URL Encoded Parser.
+     */
+    addUrlEncodedParser(options?: OptionsUrlencoded): void;
     addRateLimiter(options?: RateLimitOptions): void;
     /**
      * Adds a Body Parser middleware to the middleware collection using the given options.
@@ -290,9 +318,11 @@ declare class Middleware implements IMiddleware {
     /**
      * Configures the error handling middleware for the application.
      *
-     * @param errorHandling - The Express error handler function that takes care of processing errors and formulating the response.
+     * @param options - The object containing the configuration options for the error handler middleware.
+     * @param errorHandler - The Express error handler function that takes care of processing errors and formulating the response.
+     * @param showStackTrace - A boolean value indicating whether to show the stack trace in the response.
      */
-    setErrorHandler(errorHandling?: ExpressHandler): void;
+    setErrorHandler(options?: ErrorHandlerOptions): void;
     /**
      * Adds a middleware to serve static files from the specified root directory.
      * Allows the application to serve files like images, CSS, JavaScript, etc.

package/lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/core",
-  "version": "2.15.0",
+  "version": "2.16.0",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@core)",
   "author": "Richard Zampieri",
   "main": "./lib/cjs/index.js",
@@ -87,7 +87,7 @@
     "eslint-config-prettier": "9.1.0",
     "husky": "9.0.11",
     "prettier": "3.3.3",
-    "release-it": "17.5.0",
+    "release-it": "17.6.0",
     "typescript": "5.5.3",
     "vite": "5.3.3",
     "vite-tsconfig-paths": "4.3.2",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/core",
-  "version": "2.15.0",
+  "version": "2.16.0",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@core)",
   "author": "Richard Zampieri",
   "main": "./lib/cjs/index.js",
@@ -87,7 +87,7 @@
     "eslint-config-prettier": "9.1.0",
     "husky": "9.0.11",
     "prettier": "3.3.3",
-    "release-it": "17.5.0",
+    "release-it": "17.6.0",
     "typescript": "5.5.3",
     "vite": "5.3.3",
     "vite-tsconfig-paths": "4.3.2",