Merge pull request #71 from expressots/fix/render-engine-config

Fix/render engine config

Author: rsaz

src/adapter-express/application-express.ts

@@ -16,7 +16,7 @@ import { InversifyExpressServer } from "./express-utils/inversify-express-server
 import { EjsOptions, setEngineEjs } from "./render/ejs/ejs.config";
 import { Engine, EngineOptions, RenderOptions } from "./render/engine";
 import { HandlebarsOptions, setEngineHandlebars } from "./render/handlebars/hbs.config";
-import { packageResolver } from "./render/resolve-render";
+import { PugOptions, setEnginePug } from "./render/pug/pug.config";
 
 /**
  * The AppExpress class provides methods for configuring and running an Express application.
@@ -188,6 +188,9 @@ class AppExpress extends ApplicationBase implements IWebServer {
         case Engine.EJS:
           await setEngineEjs(this.app, this.renderOptions.options as EjsOptions);
           break;
+        case Engine.PUG:
+          await setEnginePug(this.app, this.renderOptions.options as PugOptions);
+          break;
         default:
           throw new Error("Unsupported engine type!");
       }
@@ -205,8 +208,6 @@ class AppExpress extends ApplicationBase implements IWebServer {
    * @param {EngineOptions} [options] - The configuration options for the view engine
    */
   public async setEngine<T extends EngineOptions>(engine: Engine, options?: T): Promise<void> {
-    packageResolver(engine, options);
-
     try {
       if (options) {
         this.renderOptions = { engine, options };

src/adapter-express/express-utils/constants.ts

@@ -17,6 +17,8 @@ export const HTTP_CODE_METADATA = {
   path: "inversify-express-utils:path",
 };
 
+export const RENDER_METADATA_KEY = Symbol("Render");
+
 export enum PARAMETER_TYPE {
   REQUEST,
   RESPONSE,

src/adapter-express/express-utils/decorators.ts

@@ -7,6 +7,7 @@ import {
   PARAMETER_TYPE,
   HTTP_VERBS_ENUM,
   HTTP_CODE_METADATA,
+  RENDER_METADATA_KEY,
 } from "./constants";
 import type {
   Controller,
@@ -383,6 +384,29 @@ export function params(type: PARAMETER_TYPE, parameterName?: string): ParameterD
   };
 }
 
+/**
+ * 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 function Render(template: string, defaultData?: Record<string, unknown>): MethodDecorator {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  return (target: object, propertyKey: string | symbol, descriptor: PropertyDescriptor): void => {
+    Reflect.defineMetadata(RENDER_METADATA_KEY, { template, defaultData }, target, propertyKey);
+  };
+}
+
+export function getRenderMetadata(
+  target: object,
+  propertyKey: string | symbol,
+): {
+  template?: string;
+  defaultData?: Record<string, unknown>;
+} {
+  return Reflect.getMetadata(RENDER_METADATA_KEY, target, propertyKey) || {};
+}
+
 /**
  * Converts a string value to the specified type.
  * @param value The value to convert.

src/adapter-express/express-utils/inversify-express-server.ts

@@ -40,6 +40,7 @@ import type {
   RoutingConfig,
 } from "./interfaces";
 import type { OutgoingHttpHeaders } from "node:http";
+import { getRenderMetadata } from "./decorators";
 
 export class InversifyExpressServer {
   private _router: Router;
@@ -245,21 +246,26 @@ export class InversifyExpressServer {
     controllerName: string,
     key: string,
     parameterMetadata: Array<ParameterMetadata>,
-  ): express.RequestHandler {
+  ): RequestHandler {
     return async (req: Request, res: Response, next: NextFunction): Promise<void> => {
       try {
         const args = this.extractParameters(req, res, next, parameterMetadata);
         const httpContext = this._getHttpContext(req);
         httpContext.container.bind<HttpContext>(TYPE.HttpContext).toConstantValue(httpContext);
 
         // invoke controller's action
-        const value = await (
-          httpContext.container.getNamed<BaseController>(TYPE.Controller, controllerName)[
-            key
-          ] as ControllerHandler
-        )(...args);
-
-        if (value instanceof HttpResponseMessage) {
+        const controller = httpContext.container.getNamed<BaseController>(
+          TYPE.Controller,
+          controllerName,
+        );
+        const value = await (controller[key] as ControllerHandler)(...args);
+
+        const { template, defaultData } = getRenderMetadata(controller, key);
+
+        if (template) {
+          const data = value || defaultData || {};
+          res.render(template, data as Record<string, unknown>);
+        } else if (value instanceof HttpResponseMessage) {
           await this.handleHttpResponseMessage(value, res);
         } else if (instanceOfIHttpActionResult(value)) {
           const httpResponseMessage = await value.executeAsync();

src/adapter-express/render/ejs/ejs.config.ts

@@ -1,6 +1,7 @@
 import { Application } from "express";
 import { join } from "path";
 import { Options } from "./ejs.types";
+import { packageResolver } from "../resolve-render";
 
 /**
  * Ejs options
@@ -37,6 +38,8 @@ export async function setEngineEjs(
   app: Application,
   options: EjsOptions = EJS_DEFAULTS,
 ): Promise<void> {
+  packageResolver("ejs");
+
   app.set("view engine", options.viewEngine || EJS_DEFAULTS.viewEngine);
   app.set("views", options.viewsDir || EJS_DEFAULTS.viewsDir);
 

src/adapter-express/render/engine.ts

@@ -20,6 +20,7 @@ export type RenderOptions = {
 export enum Engine {
   HBS = "hbs",
   EJS = "ejs",
+  PUG = "pug",
 }
 
 /**

src/adapter-express/render/handlebars/hbs.config.ts

@@ -1,6 +1,7 @@
 import express from "express";
 import { join } from "path";
 import { Logger } from "@expressots/core";
+import { packageResolver } from "../resolve-render";
 
 /**
  * Handlebars options
@@ -11,9 +12,9 @@ import { Logger } from "@expressots/core";
  *
  */
 export type HandlebarsOptions = {
-  viewsDir?: string | Array<string>;
   viewEngine?: string;
-  serverOptions?: unknown;
+  viewsDir?: string;
+  partialsDir?: string;
 };
 
 /**
@@ -23,11 +24,16 @@ export type HandlebarsOptions = {
  * @default
  */
 const HANDLEBARS_DEFAULTS: HandlebarsOptions = {
-  viewsDir: join(process.cwd(), "views"),
   viewEngine: "hbs",
-  serverOptions: {},
+  viewsDir: join(process.cwd(), "views"),
+  partialsDir: join(process.cwd(), "views/partials"),
 };
 
+/**
+ * Default partials directory
+ */
+const DEFAULT_PARTIALS_DIR: string = join(process.cwd(), "views/partials");
+
 /**
  * Set Handlebars as the view engine
  * @param {express.Application} app - The express application
@@ -40,21 +46,12 @@ export async function setEngineHandlebars(
   const logger = new Logger();
 
   try {
-    app.set("view engine", options.viewEngine || (HANDLEBARS_DEFAULTS.viewEngine as string));
-    app.set("views", options.viewsDir || (HANDLEBARS_DEFAULTS.viewsDir as string));
+    const hbs = packageResolver("hbs");
 
-    if (Array.isArray(options.viewsDir)) {
-      options.viewsDir.forEach((dir) => {
-        app.set("views", dir);
-      });
-    }
+    hbs.registerPartials(options.partialsDir || DEFAULT_PARTIALS_DIR);
 
-    if (options.serverOptions) {
-      app.locals = {
-        ...app.locals,
-        ...(options.serverOptions as Record<string, unknown>),
-      };
-    }
+    app.set("view engine", options.viewEngine || (HANDLEBARS_DEFAULTS.viewEngine as string));
+    app.set("views", options.viewsDir || (HANDLEBARS_DEFAULTS.viewsDir as string));
   } catch (error: unknown) {
     logger.error((error as Error).message, "handlebars-config");
   }

src/adapter-express/render/index.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";

src/adapter-express/render/pug/pug.config.ts

@@ -0,0 +1,40 @@
+import { join } from "path";
+import { packageResolver } from "../resolve-render";
+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;
+};
+
+/**
+ * Pug defaults
+ * @type {PugOptions}
+ * @constant
+ * @default
+ */
+const PUG_DEFAULTS: PugOptions = {
+  viewEngine: "pug",
+  viewsDir: 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
+ */
+export async function setEnginePug(
+  app: Application,
+  options: PugOptions = PUG_DEFAULTS,
+): Promise<void> {
+  packageResolver("pug");
+
+  app.set("view engine", options.viewEngine || (PUG_DEFAULTS.viewEngine as string));
+  app.set("views", options.viewsDir || (PUG_DEFAULTS.viewsDir as string));
+}