@expressots/adapter-express 1.6.0 → 1.7.0

package/lib/CHANGELOG.md

@@ -1,5 +1,20 @@
 
 
+## [1.7.0](https://github.com/expressots/adapter-express/compare/1.6.0...1.7.0) (2024-07-23)
+
+
+### Features
+
+* add @Render decorator ([522d6e2](https://github.com/expressots/adapter-express/commit/522d6e27163b1ec638a9d5328fb3bf5f81054c5c))
+* add pug engine support ([a879f96](https://github.com/expressots/adapter-express/commit/a879f9642dccd74a49b9188a25fcd1bbf30eb8ba))
+* bump husky from 9.0.11 to 9.1.1 ([7c1678a](https://github.com/expressots/adapter-express/commit/7c1678abf4a78e52483fff190524c5658dba1100))
+* bump vite from 5.3.3 to 5.3.4 ([86f51a3](https://github.com/expressots/adapter-express/commit/86f51a3f5f920fcc7a760730e877ae830fa574e5))
+
+
+### Bug Fixes
+
+* add options to ejs and hbs support ([b52ce5c](https://github.com/expressots/adapter-express/commit/b52ce5c3860ea7d859534d96cee030dbc4ffc19c))
+
 ## [1.6.0](https://github.com/expressots/adapter-express/compare/1.5.0...1.6.0) (2024-07-17)
 
 

package/lib/cjs/adapter-express/application-express.js

@@ -20,7 +20,7 @@ const inversify_express_server_1 = require("./express-utils/inversify-express-se
 const ejs_config_1 = require("./render/ejs/ejs.config");
 const engine_1 = require("./render/engine");
 const hbs_config_1 = require("./render/handlebars/hbs.config");
-const resolve_render_1 = require("./render/resolve-render");
+const pug_config_1 = require("./render/pug/pug.config");
 /**
  * The AppExpress class provides methods for configuring and running an Express application.
  * @class AppExpress
@@ -163,6 +163,9 @@ let AppExpress = class AppExpress extends application_express_base_1.Application
                 case engine_1.Engine.EJS:
                     await (0, ejs_config_1.setEngineEjs)(this.app, this.renderOptions.options);
                     break;
+                case engine_1.Engine.PUG:
+                    await (0, pug_config_1.setEnginePug)(this.app, this.renderOptions.options);
+                    break;
                 default:
                     throw new Error("Unsupported engine type!");
             }
@@ -179,7 +182,6 @@ let AppExpress = class AppExpress extends application_express_base_1.Application
      * @param {EngineOptions} [options] - The configuration options for the view engine
      */
     async setEngine(engine, options) {
-        (0, resolve_render_1.packageResolver)(engine, options);
         try {
             if (options) {
                 this.renderOptions = { engine, options };

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_ROUTING_ROOT_PATH = exports.NO_CONTROLLERS_FOUND = exports.DUPLICATED_CONTROLLER_NAME = exports.HTTP_VERBS_ENUM = exports.PARAMETER_TYPE = exports.HTTP_CODE_METADATA = exports.METADATA_KEY = exports.TYPE = void 0;
+exports.DEFAULT_ROUTING_ROOT_PATH = exports.NO_CONTROLLERS_FOUND = exports.DUPLICATED_CONTROLLER_NAME = exports.HTTP_VERBS_ENUM = exports.PARAMETER_TYPE = exports.RENDER_METADATA_KEY = exports.HTTP_CODE_METADATA = exports.METADATA_KEY = exports.TYPE = void 0;
 exports.TYPE = {
     AuthProvider: Symbol.for("AuthProvider"),
     Controller: Symbol.for("Controller"),
@@ -17,6 +17,7 @@ exports.HTTP_CODE_METADATA = {
     statusCode: "inversify-express-utils:statuscode",
     path: "inversify-express-utils:path",
 };
+exports.RENDER_METADATA_KEY = Symbol("Render");
 var PARAMETER_TYPE;
 (function (PARAMETER_TYPE) {
     PARAMETER_TYPE[PARAMETER_TYPE["REQUEST"] = 0] = "REQUEST";

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

@@ -12,6 +12,8 @@ exports.Head = Head;
 exports.Delete = Delete;
 exports.httpMethod = httpMethod;
 exports.params = params;
+exports.Render = Render;
+exports.getRenderMetadata = getRenderMetadata;
 require("reflect-metadata");
 const inversify_1 = require("inversify");
 const constants_1 = require("./constants");
@@ -301,6 +303,21 @@ function params(type, parameterName) {
         Reflect.defineMetadata(constants_1.METADATA_KEY.controllerParameter, metadataList, target.constructor);
     };
 }
+/**
+ * Render decorator to define the template and default data for a route
+ * @param template The template to render
+ * @param defaultData The default data to pass to the template
+ * @returns
+ */
+function Render(template, defaultData) {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    return (target, propertyKey, descriptor) => {
+        Reflect.defineMetadata(constants_1.RENDER_METADATA_KEY, { template, defaultData }, target, propertyKey);
+    };
+}
+function getRenderMetadata(target, propertyKey) {
+    return Reflect.getMetadata(constants_1.RENDER_METADATA_KEY, target, propertyKey) || {};
+}
 /**
  * Converts a string value to the specified type.
  * @param value The value to convert.

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

@@ -30,6 +30,7 @@ const base_middleware_1 = require("./base-middleware");
 const utils_1 = require("./utils");
 const constants_1 = require("./constants");
 const httpResponseMessage_1 = require("./httpResponseMessage");
+const decorators_1 = require("./decorators");
 class InversifyExpressServer {
     /**
      * Wrapper for the express server.
@@ -182,8 +183,14 @@ class InversifyExpressServer {
                 const httpContext = this._getHttpContext(req);
                 httpContext.container.bind(constants_1.TYPE.HttpContext).toConstantValue(httpContext);
                 // invoke controller's action
-                const value = await httpContext.container.getNamed(constants_1.TYPE.Controller, controllerName)[key](...args);
-                if (value instanceof httpResponseMessage_1.HttpResponseMessage) {
+                const controller = httpContext.container.getNamed(constants_1.TYPE.Controller, controllerName);
+                const value = await controller[key](...args);
+                const { template, defaultData } = (0, decorators_1.getRenderMetadata)(controller, key);
+                if (template) {
+                    const data = value || defaultData || {};
+                    res.render(template, data);
+                }
+                else if (value instanceof httpResponseMessage_1.HttpResponseMessage) {
                     await this.handleHttpResponseMessage(value, res);
                 }
                 else if ((0, utils_1.instanceOfIHttpActionResult)(value)) {

package/lib/cjs/adapter-express/render/ejs/ejs.config.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setEngineEjs = setEngineEjs;
 const path_1 = require("path");
+const resolve_render_1 = require("../resolve-render");
 /**
  * Ejs defaults
  * @type {EjsOptions}
@@ -19,6 +20,7 @@ const EJS_DEFAULTS = {
  * @param {EjsOptions} [options=EJS_DEFAULTS] - The ejs options
  */
 async function setEngineEjs(app, options = EJS_DEFAULTS) {
+    (0, resolve_render_1.packageResolver)("ejs");
     app.set("view engine", options.viewEngine || EJS_DEFAULTS.viewEngine);
     app.set("views", options.viewsDir || EJS_DEFAULTS.viewsDir);
     if (Array.isArray(options.viewsDir)) {

package/lib/cjs/adapter-express/render/engine.js

@@ -11,4 +11,5 @@ var Engine;
 (function (Engine) {
     Engine["HBS"] = "hbs";
     Engine["EJS"] = "ejs";
+    Engine["PUG"] = "pug";
 })(Engine || (exports.Engine = Engine = {}));

package/lib/cjs/adapter-express/render/handlebars/hbs.config.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.setEngineHandlebars = setEngineHandlebars;
 const path_1 = require("path");
 const core_1 = require("@expressots/core");
+const resolve_render_1 = require("../resolve-render");
 /**
  * Handlebars defaults
  * @type {HandlebarsOptions}
@@ -10,10 +11,14 @@ const core_1 = require("@expressots/core");
  * @default
  */
 const HANDLEBARS_DEFAULTS = {
-    viewsDir: (0, path_1.join)(process.cwd(), "views"),
     viewEngine: "hbs",
-    serverOptions: {},
+    viewsDir: (0, path_1.join)(process.cwd(), "views"),
+    partialsDir: (0, path_1.join)(process.cwd(), "views/partials"),
 };
+/**
+ * Default partials directory
+ */
+const DEFAULT_PARTIALS_DIR = (0, path_1.join)(process.cwd(), "views/partials");
 /**
  * Set Handlebars as the view engine
  * @param {express.Application} app - The express application
@@ -22,19 +27,10 @@ const HANDLEBARS_DEFAULTS = {
 async function setEngineHandlebars(app, options = HANDLEBARS_DEFAULTS) {
     const logger = new core_1.Logger();
     try {
+        const hbs = (0, resolve_render_1.packageResolver)("hbs");
+        hbs.registerPartials(options.partialsDir || DEFAULT_PARTIALS_DIR);
         app.set("view engine", options.viewEngine || HANDLEBARS_DEFAULTS.viewEngine);
         app.set("views", options.viewsDir || HANDLEBARS_DEFAULTS.viewsDir);
-        if (Array.isArray(options.viewsDir)) {
-            options.viewsDir.forEach((dir) => {
-                app.set("views", dir);
-            });
-        }
-        if (options.serverOptions) {
-            app.locals = {
-                ...app.locals,
-                ...options.serverOptions,
-            };
-        }
     }
     catch (error) {
         logger.error(error.message, "handlebars-config");

package/lib/cjs/adapter-express/render/pug/pug.config.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setEnginePug = setEnginePug;
+const path_1 = require("path");
+const resolve_render_1 = require("../resolve-render");
+/**
+ * Pug defaults
+ * @type {PugOptions}
+ * @constant
+ * @default
+ */
+const PUG_DEFAULTS = {
+    viewEngine: "pug",
+    viewsDir: (0, path_1.join)(process.cwd(), "views"),
+};
+/**
+ * Set Pug as the view engine
+ * @param {express.Application} app - The express application
+ * @param {PugOptions} [options=PUG_DEFAULTS] - The pug options
+ */
+async function setEnginePug(app, options = PUG_DEFAULTS) {
+    (0, resolve_render_1.packageResolver)("pug");
+    app.set("view engine", options.viewEngine || PUG_DEFAULTS.viewEngine);
+    app.set("views", options.viewsDir || PUG_DEFAULTS.viewsDir);
+}

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

@@ -14,6 +14,7 @@ export declare const HTTP_CODE_METADATA: {
     statusCode: string;
     path: string;
 };
+export declare const RENDER_METADATA_KEY: unique symbol;
 export declare enum PARAMETER_TYPE {
     REQUEST = 0,
     RESPONSE = 1,

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

@@ -121,3 +121,14 @@ export declare const principal: () => ParameterDecorator;
  * @returns ParameterDecorator
  */
 export declare function params(type: PARAMETER_TYPE, parameterName?: string): ParameterDecorator;
+/**
+ * Render decorator to define the template and default data for a route
+ * @param template The template to render
+ * @param defaultData The default data to pass to the template
+ * @returns
+ */
+export declare function Render(template: string, defaultData?: Record<string, unknown>): MethodDecorator;
+export declare function getRenderMetadata(target: object, propertyKey: string | symbol): {
+    template?: string;
+    defaultData?: Record<string, unknown>;
+};

package/lib/cjs/types/adapter-express/render/engine.d.ts

@@ -17,7 +17,8 @@ export type RenderOptions = {
  */
 export declare enum Engine {
     HBS = "hbs",
-    EJS = "ejs"
+    EJS = "ejs",
+    PUG = "pug"
 }
 /**
  * The configuration options for the view engine.

package/lib/cjs/types/adapter-express/render/handlebars/hbs.config.d.ts

@@ -8,9 +8,9 @@ import express from "express";
  *
  */
 export type HandlebarsOptions = {
-    viewsDir?: string | Array<string>;
     viewEngine?: string;
-    serverOptions?: unknown;
+    viewsDir?: string;
+    partialsDir?: string;
 };
 /**
  * Set Handlebars as the view engine

package/lib/cjs/types/adapter-express/render/index.d.ts

@@ -1,3 +1,4 @@
 export { EjsOptions as EJS } from "./ejs/ejs.config";
 export { HandlebarsOptions as HBS } from "./handlebars/hbs.config";
+export { PugOptions as PUG } from "./pug/pug.config";
 export { Engine } from "./engine";

package/lib/cjs/types/adapter-express/render/pug/pug.config.d.ts

@@ -0,0 +1,17 @@
+import { Application } from "express";
+/**
+ * Pug options
+ * @typedef {Object} PugOptions
+ * @property {string} viewEngine - The view engine to be used
+ * @property {string} viewsDir - The path to the views folder
+ */
+export type PugOptions = {
+    viewEngine?: string;
+    viewsDir?: string;
+};
+/**
+ * Set Pug as the view engine
+ * @param {express.Application} app - The express application
+ * @param {PugOptions} [options=PUG_DEFAULTS] - The pug options
+ */
+export declare function setEnginePug(app: Application, options?: PugOptions): Promise<void>;

package/lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/adapter-express",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@adapter-express)",
   "author": "",
   "main": "./lib/cjs/index.js",
@@ -84,11 +84,11 @@
     "@vitest/coverage-v8": "2.0.3",
     "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
-    "husky": "9.0.11",
+    "husky": "9.1.1",
     "prettier": "3.3.3",
     "release-it": "17.6.0",
     "typescript": "5.5.3",
-    "vite": "5.3.3",
+    "vite": "5.3.4",
     "vite-tsconfig-paths": "4.3.2",
     "vitest": "2.0.3"
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/adapter-express",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@adapter-express)",
   "author": "",
   "main": "./lib/cjs/index.js",
@@ -84,11 +84,11 @@
     "@vitest/coverage-v8": "2.0.3",
     "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
-    "husky": "9.0.11",
+    "husky": "9.1.1",
     "prettier": "3.3.3",
     "release-it": "17.6.0",
     "typescript": "5.5.3",
-    "vite": "5.3.3",
+    "vite": "5.3.4",
     "vite-tsconfig-paths": "4.3.2",
     "vitest": "2.0.3"
   },