@expressots/adapter-express 1.7.0 → 1.8.0

package/lib/CHANGELOG.md

@@ -1,5 +1,27 @@
 
 
+## [1.8.0](https://github.com/expressots/adapter-express/compare/1.7.0...1.8.0) (2024-08-13)
+
+
+### Features
+
+* add expressots middleware in decorators ([055ead9](https://github.com/expressots/adapter-express/commit/055ead94334dd5ea735ddf04a16a322d56d566cc))
+* add FileUpload decorator ([a4f62b1](https://github.com/expressots/adapter-express/commit/a4f62b1cd377625c55218069599a7a262493e3f5))
+
+
+### Bug Fixes
+
+* adjust error msgs and package resolver ([34a0fcd](https://github.com/expressots/adapter-express/commit/34a0fcde6e637130e328733f48130408fa881a67))
+* adjust isExpressoMiddleware function param types ([edc0888](https://github.com/expressots/adapter-express/commit/edc0888489df4c9f33a5b97af0820ce8f90904e9))
+* return message ([32d656e](https://github.com/expressots/adapter-express/commit/32d656ec2b05a807599e428c9bd0389849c2165d))
+
+
+### Code Refactoring
+
+* bump expresso core deps & remove husky deprecated code ([a9b243f](https://github.com/expressots/adapter-express/commit/a9b243fd35b877c839da2871401574cf30db808e))
+* httpMethod to Method decorator ([5e853a0](https://github.com/expressots/adapter-express/commit/5e853a04358430e9e6f658bf0d0b68b7e2708a24))
+* remove unnecessary comments ([72c4a15](https://github.com/expressots/adapter-express/commit/72c4a157055fffdfbaad19a69ea124ca0eb7fa13))
+
 ## [1.7.0](https://github.com/expressots/adapter-express/compare/1.6.0...1.7.0) (2024-07-23)
 
 

package/lib/cjs/adapter-express/express-utils/decorators.js

@@ -10,13 +10,16 @@ exports.Put = Put;
 exports.Patch = Patch;
 exports.Head = Head;
 exports.Delete = Delete;
-exports.httpMethod = httpMethod;
+exports.Method = Method;
 exports.params = params;
 exports.Render = Render;
 exports.getRenderMetadata = getRenderMetadata;
+exports.FileUpload = FileUpload;
 require("reflect-metadata");
 const inversify_1 = require("inversify");
 const constants_1 = require("./constants");
+const resolver_multer_1 = require("./resolver-multer");
+const core_1 = require("@expressots/core");
 exports.injectHttpContext = (0, inversify_1.inject)(constants_1.TYPE.HttpContext);
 /**
  * Controller decorator to define a new controller
@@ -83,7 +86,7 @@ function Http(code) {
  * @param middleware array of middleware to be applied to all routes defined in path logic
  */
 function All(path, ...middleware) {
-    return httpMethod("all", path, ...middleware);
+    return Method("all", path, ...middleware);
 }
 /**
  * Decorator to allow GET HTTP method
@@ -99,7 +102,7 @@ function Get(path, ...middleware) {
  * @param middleware array of middleware to be applied to the route
  */
 function Post(path, ...middleware) {
-    return httpMethod("post", path, ...middleware);
+    return Method("post", path, ...middleware);
 }
 /**
  * Decorator to allow PUT HTTP method
@@ -123,7 +126,7 @@ function Patch(path, ...middleware) {
  * @param middleware array of middleware to be applied to the route
  */
 function Head(path, ...middleware) {
-    return httpMethod("head", path, ...middleware);
+    return Method("head", path, ...middleware);
 }
 /**
  * Decorator to allow DELETE HTTP method
@@ -189,7 +192,7 @@ function enhancedHttpMethod(method, path, ...middleware) {
  * @param path route path
  * @param middleware array of middleware to be applied to the route
  */
-function httpMethod(method, path, ...middleware) {
+function Method(method, path, ...middleware) {
     return (target, key) => {
         const metadata = {
             key,
@@ -336,3 +339,87 @@ function convertToType(value, type) {
     }
     return value;
 }
+/**
+ * File upload decorator to handle file uploads
+ * @param options
+ * @param multerOptions
+ * @default { none: true }
+ * @returns MethodDecorator
+ */
+function FileUpload(options, multerOptions) {
+    const multer = (0, resolver_multer_1.packageResolver)("multer");
+    /* eslint-disable @typescript-eslint/no-explicit-any */
+    let upload;
+    let method = "none";
+    if (multer) {
+        if (options === undefined) {
+            options = { none: true };
+        }
+        upload = multer(multerOptions);
+        method = inferMulterMethod(options);
+    }
+    return function (target, propertyKey, descriptor) {
+        const originalMethod = descriptor.value;
+        /* eslint-disable @typescript-eslint/no-explicit-any */
+        descriptor.value = function (...args) {
+            const req = args[0];
+            const res = args[1];
+            // const next = args[2] as NextFunction;
+            const multerMiddleware = getMulterMiddleware(upload, options, method);
+            multerMiddleware(req, res, (err) => {
+                if (err) {
+                    return res.status(400).json({ error: err.message });
+                }
+                return originalMethod.apply(this, args);
+            });
+        };
+    };
+}
+/**
+ * Infer the multer method to use based on the provided options
+ * @param options
+ * @returns
+ */
+function inferMulterMethod(options) {
+    const report = new core_1.Report();
+    if (options.none)
+        return "none";
+    if (options.any)
+        return "any";
+    if (Array.isArray(options))
+        return "fields";
+    if (options.fieldName && options.maxCount !== undefined)
+        return "array";
+    if (options.fieldName)
+        return "single";
+    throw report.error("Invalid options provided for FileUpload.", core_1.StatusCode.InternalServerError, "multer-decorator");
+}
+/**
+ * Get the multer middleware based on the method
+ * @param upload
+ * @param options
+ * @param method
+ * @returns
+ */
+function getMulterMiddleware(upload, options, method) {
+    const report = new core_1.Report();
+    switch (method) {
+        case "single":
+            return upload.single(options.fieldName);
+        case "array":
+            return upload.array(options.fieldName, options.maxCount);
+        case "fields": {
+            const fieldsOptions = options.map((opt) => ({
+                name: opt.fieldName,
+                maxCount: opt.maxCount,
+            }));
+            return upload.fields(fieldsOptions);
+        }
+        case "none":
+            return upload.none();
+        case "any":
+            return upload.any();
+        default:
+            throw report.error(`Unsupported Multer method: ${method}`, core_1.StatusCode.InternalServerError, "multer-decorator");
+    }
+}

package/lib/cjs/adapter-express/express-utils/inversify-express-server.js

@@ -126,22 +126,32 @@ class InversifyExpressServer {
             const methodMetadata = (0, utils_1.getControllerMethodMetadata)(controller.constructor);
             const parameterMetadata = (0, utils_1.getControllerParameterMetadata)(controller.constructor);
             if (controllerMetadata && methodMetadata) {
-                const controllerMiddleware = this.resolveMidleware(...controllerMetadata.middleware);
+                const controllerMiddleware = this.resolveMiddleware(...controllerMetadata.middleware);
                 methodMetadata.forEach((metadata) => {
                     let paramList = [];
                     if (parameterMetadata) {
                         paramList = parameterMetadata[metadata.key] || [];
                     }
                     const handler = this.handlerFactory(controllerMetadata.target.name, metadata.key, paramList);
-                    const routeMiddleware = this.resolveMidleware(...metadata.middleware);
+                    const routeMiddleware = this.resolveMiddleware(...metadata.middleware);
                     this._router[metadata.method](`${controllerMetadata.path}${metadata.path}`, ...controllerMiddleware, ...routeMiddleware, handler);
                 });
             }
         });
         this._app.use(this._routingConfig.rootPath, this._router);
     }
-    resolveMidleware(...middleware) {
+    isExpressoMiddleware(middlewareItem) {
+        return (typeof middlewareItem === "object" &&
+            "use" in middlewareItem &&
+            typeof middlewareItem.use === "function");
+    }
+    resolveMiddleware(...middleware) {
         return middleware.map((middlewareItem) => {
+            if (this.isExpressoMiddleware(middlewareItem)) {
+                return (req, res, next) => {
+                    middlewareItem.use(req, res, next);
+                };
+            }
             if (!this._container.isBound(middlewareItem)) {
                 return middlewareItem;
             }

package/lib/cjs/adapter-express/express-utils/resolver-multer.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.packageResolver = packageResolver;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const core_1 = require("@expressots/core");
+/**
+ * Resolve package from the current working directory.
+ * @param packageName
+ * @param options
+ * @returns
+ */
+function packageResolver(packageName) {
+    const logger = new core_1.Logger();
+    try {
+        const hasPackage = require.resolve(packageName, {
+            paths: [process.cwd()],
+        });
+        if (hasPackage) {
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const packageResolved = require(hasPackage);
+            if (typeof packageResolved === "function") {
+                return packageResolved;
+            }
+            if (packageResolved.default && typeof packageResolved.default === "function") {
+                return packageResolved.default;
+            }
+            return packageResolved;
+        }
+    }
+    catch (error) {
+        logger.warn(`Package [${packageName}] not installed. Please install it using your package manager.`, "package-resolver");
+    }
+}

package/lib/cjs/types/adapter-express/express-utils/decorators.d.ts

@@ -70,7 +70,7 @@ export declare function Delete(path: string, ...middleware: Array<Middleware>):
  * @param path route path
  * @param middleware array of middleware to be applied to the route
  */
-export declare function httpMethod(method: keyof typeof HTTP_VERBS_ENUM, path: string, ...middleware: Array<Middleware>): HandlerDecorator;
+export declare function Method(method: keyof typeof HTTP_VERBS_ENUM, path: string, ...middleware: Array<Middleware>): HandlerDecorator;
 /**
  * Parameter decorator to inject the request object
  * @returns ParameterDecorator
@@ -132,3 +132,51 @@ export declare function getRenderMetadata(target: object, propertyKey: string |
     template?: string;
     defaultData?: Record<string, unknown>;
 };
+export interface StorageEngine {
+    _handleFile(req: unknown, file: MulterFile, callback: (error?: Error | null, info?: Partial<MulterFile>) => void): void;
+    _removeFile(req: unknown, file: MulterFile, callback: (error: Error | null) => void): void;
+}
+export interface MulterFile {
+    fieldname: string;
+    originalname: string;
+    encoding: string;
+    mimetype: string;
+    size: number;
+    destination?: string;
+    filename?: string;
+    path?: string;
+    buffer?: Buffer;
+}
+export interface MulterLimits {
+    fieldNameSize?: number;
+    fieldSize?: number;
+    fields?: number;
+    fileSize?: number;
+    files?: number;
+    parts?: number;
+    headerPairs?: number;
+}
+export interface MulterOptions {
+    dest?: string;
+    storage?: StorageEngine;
+    limits?: MulterLimits;
+    fileFilter?: FileFilter;
+}
+export type FileFilterCallback = (error: Error | null, acceptFile: boolean) => void;
+export type FileFilter = (req: unknown, file: MulterFile, callback: FileFilterCallback) => void;
+type FieldOptions = {
+    fieldName: string;
+    maxCount?: number;
+};
+/**
+ * File upload decorator to handle file uploads
+ * @param options
+ * @param multerOptions
+ * @default { none: true }
+ * @returns MethodDecorator
+ */
+export declare function FileUpload(options?: FieldOptions | Array<FieldOptions> | {
+    none?: boolean;
+    any?: boolean;
+}, multerOptions?: MulterOptions): MethodDecorator;
+export {};

package/lib/cjs/types/adapter-express/express-utils/interfaces.d.ts

@@ -12,7 +12,10 @@ interface ConstructorFunction<T = Record<string, unknown>> {
     prototype: Prototype<T>;
 }
 export type DecoratorTarget<T = unknown> = ConstructorFunction<T> | Prototype<T>;
-export type Middleware = string | symbol | RequestHandler;
+export interface IExpressoMiddleware {
+    use(req: Request, res: Response, next: NextFunction): Promise<void> | void;
+}
+export type Middleware = string | symbol | RequestHandler | IExpressoMiddleware;
 export type ControllerHandler = (...params: Array<unknown>) => unknown;
 export type BaseController = Record<string, ControllerHandler>;
 export interface Controller {

package/lib/cjs/types/adapter-express/express-utils/inversify-express-server.d.ts

@@ -46,7 +46,8 @@ export declare class InversifyExpressServer {
      */
     build(): express.Application;
     private registerControllers;
-    private resolveMidleware;
+    private isExpressoMiddleware;
+    private resolveMiddleware;
     private copyHeadersTo;
     private handleHttpResponseMessage;
     private handlerFactory;

package/lib/cjs/types/adapter-express/express-utils/resolver-multer.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Resolve package from the current working directory.
+ * @param packageName
+ * @param options
+ * @returns
+ */
+export declare function packageResolver(packageName: string): any;

package/lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/adapter-express",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@adapter-express)",
   "author": "",
   "main": "./lib/cjs/index.js",
@@ -75,7 +75,7 @@
     "@codecov/vite-plugin": "^0.0.1-beta.6",
     "@commitlint/cli": "19.2.1",
     "@commitlint/config-conventional": "19.2.2",
-    "@expressots/core": "2.15.0",
+    "@expressots/core": "2.16.0",
     "@release-it/conventional-changelog": "8.0.1",
     "@types/express": "4.17.21",
     "@types/node": "20.14.10",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/adapter-express",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@adapter-express)",
   "author": "",
   "main": "./lib/cjs/index.js",
@@ -75,7 +75,7 @@
     "@codecov/vite-plugin": "^0.0.1-beta.6",
     "@commitlint/cli": "19.2.1",
     "@commitlint/config-conventional": "19.2.2",
-    "@expressots/core": "2.15.0",
+    "@expressots/core": "2.16.0",
     "@release-it/conventional-changelog": "8.0.1",
     "@types/express": "4.17.21",
     "@types/node": "20.14.10",