html-express-js 4.2.0 → 4.3.0

package/package.json

@@ -1,11 +1,23 @@
 {
   "name": "html-express-js",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "An Express template engine to render HTML views using native JavaScript",
   "main": "src/index.js",
   "type": "module",
   "engines": {
-    "node": ">=22.19"
+    "node": ">=16"
+  },
+  "devEngines": {
+    "runtime": {
+      "name": "node",
+      "version": ">=22.19",
+      "onFail": "error"
+    },
+    "packageManager": {
+      "name": "npm",
+      "version": ">=10.9.3",
+      "onFail": "error"
+    }
   },
   "files": [
     "src/index.js",

package/src/index.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Generates HTML for the provided view and adds all includes to state object.
+ *
+ * @param {string} filePath - The path to html file
+ * @param {import('express').Request} req - The request to build the state from
+ * @param {Record<string, any>} [data] - Data provided to the view
+ * @returns {Promise<string>} HTML with includes available (appended to state)
+ */
+export function buildStateViewHtml(filePath: string, req: import("express").Request, data?: Record<string, any>): Promise<string>;
 /**
  * Renders a JS HTML file and adds all includes to state object.
  *
@@ -8,6 +17,15 @@
  * @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>): Promise<string>;
+/**
+ * Renders a JS HTML file and adds all includes to state object.
+ *
+ * @param {string} filePath - The path to html file
+ * @param {object} data - Data to be made available in view
+ * @param {Record<string, any>} [customState]
+ * @returns {Promise<string>} HTML with includes available (appended to state)
+ */
+export function buildViewHtml(filePath: string, data?: object, customState?: Record<string, any>): Promise<string>;
 /**
  * Template literal that supports string
  * interpolating in passed HTML.

package/src/index.js

@@ -54,7 +54,7 @@ let buildRequestState;
 let notFoundView = `404/index`;
 
 /**
- * Renders an HTML template in a file.
+ * Generates the HTML for a view function inside of the passed file.
  *
  * @private
  * @param {string} path - The path to html file
@@ -62,7 +62,7 @@ let notFoundView = `404/index`;
  * @param {object} [state] - Page-level attributes
  * @returns {Promise<string>} HTML
  */
-async function renderFileTemplate(path, data, state) {
+async function buildView(path, data, state) {
   const { view } = await import(path);
   const rendered = view(data, state);
   let html = '';
@@ -72,6 +72,19 @@ async function renderFileTemplate(path, data, state) {
   return html;
 }
 
+/**
+ * Generates HTML for the provided view and adds all includes to state object.
+ *
+ * @param {string} filePath - The path to html file
+ * @param {import('express').Request} req - The request to build the state from
+ * @param {Record<string, any>} [data] - Data provided to the view
+ * @returns {Promise<string>} HTML with includes available (appended to state)
+ */
+export async function buildStateViewHtml(filePath, req, data = {}) {
+  const requestState = buildRequestState ? await buildRequestState(req) : {};
+  return await buildViewHtml(filePath, data, requestState);
+}
+
 /**
  * Renders a JS HTML file and adds all includes to state object.
  *
@@ -82,8 +95,8 @@ async function renderFileTemplate(path, data, state) {
  * @returns {Promise<string>} HTML with includes available (appended to state)
  */
 export async function renderView(filePath, req, res, data = {}) {
-  const requestState = buildRequestState ? await buildRequestState(req) : {};
-  const html = await buildViewHtml(filePath, data, requestState);
+  const html = await buildStateViewHtml(filePath, req, data);
+  res.set('Content-Type', 'text/html');
   res.send(html);
   return html;
 }
@@ -96,7 +109,7 @@ export async function renderView(filePath, req, res, data = {}) {
  * @param {Record<string, any>} [customState]
  * @returns {Promise<string>} HTML with includes available (appended to state)
  */
-async function buildViewHtml(filePath, data = {}, customState = {}) {
+export async function buildViewHtml(filePath, data = {}, customState = {}) {
   /**
    * @type {Record<string, any>}
    */
@@ -105,9 +118,9 @@ async function buildViewHtml(filePath, data = {}, customState = {}) {
   const includeFilePaths = await glob(`${includesDir}/*.js`);
   for await (const includePath of includeFilePaths) {
     const key = basename(includePath, '.js');
-    state.includes[key] = await renderFileTemplate(includePath, data, state);
+    state.includes[key] = await buildView(includePath, data, state);
   }
-  return await renderFileTemplate(`${viewsDir}/${filePath}.js`, data, state);
+  return await buildView(`${viewsDir}/${filePath}.js`, data, state);
 }
 
 /**