html-express-js 3.1.0 → 4.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-express-js",
-  "version": "3.1.0",
+  "version": "4.1.0",
   "description": "An Express template engine to render HTML views using native JavaScript",
   "main": "src/index.js",
   "type": "module",
@@ -39,23 +39,23 @@
   },
   "homepage": "https://github.com/markcellus/html-express-js#readme",
   "dependencies": {
-    "glob": "^10.2.2"
+    "glob": "^11.0.0"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.13",
-    "@types/express": "^4.17.21",
+    "@types/chai": "^5.0.0",
+    "@types/express": "^5.0.0",
     "@types/mocha": "^10.0.6",
     "@types/reload": "^3.2.3",
     "@types/sinon": "^17.0.3",
     "chai": "^5.1.0",
-    "chokidar": "^3.5.3",
-    "express": "^4.18.1",
+    "chokidar": "^4.0.1",
+    "express": "^5.1.0",
     "husky": "^9.0.7",
-    "mocha": "^10.3.0",
+    "mocha": "^11.0.1",
     "prettier": "^3.0.3",
-    "release-it": "^17.1.1",
+    "release-it": "17.1.1",
     "reload": "^3.2.0",
-    "sinon": "^17.0.1",
+    "sinon": "^21.0.0",
     "typescript": "^5.4.3"
   }
 }

package/src/index.d.ts

@@ -5,9 +5,9 @@
  * @param {import('express').Request} req
  * @param {import('express').Response} res
  * @param {Record<string, any>} [data]
- * @returns {Promise<void>} HTML with includes available (appended to state)
+ * @returns {Promise<string>} HTML with includes available (appended to state)
  */
-export function renderView(filePath: string, req: import('express').Request, res: import('express').Response, data?: Record<string, any> | undefined): Promise<void>;
+export function renderView(filePath: string, req: import("express").Request, res: import("express").Response, data?: Record<string, any>): Promise<string>;
 /**
  * Template literal that supports string
  * interpolating in passed HTML.
@@ -27,12 +27,12 @@ export function html(strings: any, ...data: any[]): string;
  * engine: Parameters<import('express').Application['engine']>[1],
  * }}
  */
-export default function _default(opts?: HTMLExpressOptions | undefined): {
+export default function _default(opts?: HTMLExpressOptions): {
     staticIndexHandler: HTMLExpressStaticIndexHandler;
-    engine: [ext: string, fn: (path: string, options: object, callback: (e: any, rendered?: string | undefined) => void) => void][1];
+    engine: Parameters<import("express").Application["engine"]>[1];
 };
-export type HTMLExpressStaticIndexHandler = () => import('express').RequestHandler;
-export type HTMLExpressBuildStateHandler = (req: import('express').Request) => Record<string, any>;
+export type HTMLExpressStaticIndexHandler = () => import("express").RequestHandler;
+export type HTMLExpressBuildStateHandler = (req: import("express").Request) => Promise<Record<string, any>>;
 export type HTMLExpressOptions = {
     /**
      * - The directory that houses any potential index files
@@ -58,5 +58,3 @@ export type HTMLExpressViewState = Record<string, string> & {
     includes: Record<string, string>;
 };
 export type HTMLExpressView<D extends Record<string, any> = Record<string, any>> = (data: D, state: HTMLExpressViewState) => string;
-declare function staticIndexHandler(): import('express').RequestHandler;
-export {};

package/src/index.js

@@ -5,7 +5,7 @@ import { stat } from 'fs/promises';
 /**
  * @callback HTMLExpressBuildStateHandler
  * @param {import('express').Request} req
- * @returns {Record<string, any>}
+ * @returns {Promise<Record<string, any>>}
  */
 
 /**
@@ -79,12 +79,13 @@ async function renderFileTemplate(path, data, state) {
  * @param {import('express').Request} req
  * @param {import('express').Response} res
  * @param {Record<string, any>} [data]
- * @returns {Promise<void>} HTML with includes available (appended to state)
+ * @returns {Promise<string>} HTML with includes available (appended to state)
  */
 export async function renderView(filePath, req, res, data = {}) {
-  const requestState = buildRequestState ? buildRequestState(req) : {};
+  const requestState = buildRequestState ? await buildRequestState(req) : {};
   const html = await buildViewHtml(filePath, data, requestState);
   res.send(html);
+  return html;
 }
 
 /**