@sitecore-jss/sitecore-jss-rendering-host 22.3.0 → 22.3.1-canary.11

package/dist/cjs/defaultAppInvocationInfoResolver.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultAppInvocationInfoResolver = void 0;
+exports.getDefaultAppInvocationInfoResolver = getDefaultAppInvocationInfoResolver;
 const import_fresh_1 = __importDefault(require("import-fresh"));
 const path_1 = __importDefault(require("path"));
 /**
@@ -16,8 +16,7 @@ const path_1 = __importDefault(require("path"));
  * `JSSAppName` is the `id` property of the JSON request body that is POSTed to the rendering host by Sitecore.
  *
  * `serverBundleName` is the name of the JavaScript file (typically a bundle) that contains the function for rendering your app.
- *
- * @param {string} [baseAppPath='./dist'] The base path to your JSS app(s), defaults to `./dist`
+ * @param {string} [baseAppPath] The base path to your JSS app(s), defaults to `./dist`
  * @returns {AppInvocationInfoResolver} resolver
  */
 function getDefaultAppInvocationInfoResolver({ appPathResolver = (requestJson) => {
@@ -48,4 +47,3 @@ function getDefaultAppInvocationInfoResolver({ appPathResolver = (requestJson) =
     };
     return resolver;
 }
-exports.getDefaultAppInvocationInfoResolver = getDefaultAppInvocationInfoResolver;

package/dist/cjs/devServer.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.startDevServer = void 0;
+exports.startDevServer = startDevServer;
 const del_1 = require("del");
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
@@ -149,12 +149,11 @@ function startDevServer({ port = 0, tunnelUrl, configFactory, buildArtifactsPath
         invokeHook(hooks.afterDevServerStarted, server);
     });
 }
-exports.startDevServer = startDevServer;
 /**
  * @param {Function | undefined} hook
  * @param {...unknown} args
  */
-// eslint-disable-next-line @typescript-eslint/ban-types
+// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
 function invokeHook(hook, ...args) {
     if (hook && typeof hook === 'function') {
         hook(...args);

package/dist/cjs/renderingHostServer.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.startRenderingHostServer = void 0;
+exports.startRenderingHostServer = startRenderingHostServer;
 const compression_1 = __importDefault(require("compression"));
 const express_1 = __importDefault(require("express"));
 // import importFresh from 'import-fresh';
@@ -47,12 +47,11 @@ function startRenderingHostServer({ port = 0, hostname = 'localhost', hooks = {}
         invokeHook(hooks.afterServerStarted, server);
     });
 }
-exports.startRenderingHostServer = startRenderingHostServer;
 /**
  * @param {Function | undefined} hook
  * @param {...unknown} args
  */
-// eslint-disable-next-line @typescript-eslint/ban-types
+// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
 function invokeHook(hook, ...args) {
     if (hook && typeof hook === 'function') {
         hook(...args);

package/dist/cjs/ssrMiddleware.js

@@ -3,7 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tryParseJson = exports.extractJsonFromStreamData = exports.onReadableStreamDataHandler = exports.respondWithError = exports.readRequestBodyAsJson = exports.getDefaultAppRendererCallback = exports.ssrMiddleware = void 0;
+exports.ssrMiddleware = void 0;
+exports.getDefaultAppRendererCallback = getDefaultAppRendererCallback;
+exports.readRequestBodyAsJson = readRequestBodyAsJson;
+exports.respondWithError = respondWithError;
+exports.onReadableStreamDataHandler = onReadableStreamDataHandler;
+exports.extractJsonFromStreamData = extractJsonFromStreamData;
+exports.tryParseJson = tryParseJson;
 const zlib_1 = __importDefault(require("zlib")); // node.js standard lib
 // may be used by a "standalone" JSS rendering host / express server.
 const ssrMiddleware = ({ appInvocationInfoResolver, }) => {
@@ -59,7 +65,6 @@ function getDefaultAppRendererCallback(res) {
     };
     return callback;
 }
-exports.getDefaultAppRendererCallback = getDefaultAppRendererCallback;
 /**
  * @param {IncomingMessage} request
  */
@@ -75,7 +80,6 @@ function readRequestBodyAsJson(request) {
         });
     });
 }
-exports.readRequestBodyAsJson = readRequestBodyAsJson;
 /**
  * @param {ServerResponse} res
  * @param {Error} errorValue
@@ -88,9 +92,8 @@ function respondWithError(res, errorValue) {
         errorDetails: errorValue.stack || null,
     }));
 }
-exports.respondWithError = respondWithError;
 /**
- * @param {Object} dataWriter
+ * @param {object} dataWriter
  * @param {Buffer} dataWriter.output
  */
 function onReadableStreamDataHandler(dataWriter) {
@@ -103,7 +106,6 @@ function onReadableStreamDataHandler(dataWriter) {
         }
     };
 }
-exports.onReadableStreamDataHandler = onReadableStreamDataHandler;
 /**
  * @param {Buffer} data
  * @param {string} [contentEncoding]
@@ -128,7 +130,6 @@ function extractJsonFromStreamData(data, contentEncoding) {
     }
     return responseString.then(tryParseJson);
 }
-exports.extractJsonFromStreamData = extractJsonFromStreamData;
 /**
  * @param {string} jsonString
  */
@@ -145,4 +146,3 @@ function tryParseJson(jsonString) {
     }
     return null;
 }
-exports.tryParseJson = tryParseJson;

package/dist/cjs/tunnel.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.startRenderHostTunnel = void 0;
+exports.startRenderHostTunnel = startRenderHostTunnel;
 const ngrok_1 = __importDefault(require("ngrok"));
 /**
  * @param {string} renderHostname
@@ -22,4 +22,3 @@ function startRenderHostTunnel(renderHostname, options = { port: 80, proto: 'htt
         return url;
     });
 }
-exports.startRenderHostTunnel = startRenderHostTunnel;

package/dist/esm/defaultAppInvocationInfoResolver.js

@@ -10,8 +10,7 @@ import path from 'path';
  * `JSSAppName` is the `id` property of the JSON request body that is POSTed to the rendering host by Sitecore.
  *
  * `serverBundleName` is the name of the JavaScript file (typically a bundle) that contains the function for rendering your app.
- *
- * @param {string} [baseAppPath='./dist'] The base path to your JSS app(s), defaults to `./dist`
+ * @param {string} [baseAppPath] The base path to your JSS app(s), defaults to `./dist`
  * @returns {AppInvocationInfoResolver} resolver
  */
 export function getDefaultAppInvocationInfoResolver({ appPathResolver = (requestJson) => {

package/dist/esm/devServer.js

@@ -147,7 +147,7 @@ export function startDevServer({ port = 0, tunnelUrl, configFactory, buildArtifa
  * @param {Function | undefined} hook
  * @param {...unknown} args
  */
-// eslint-disable-next-line @typescript-eslint/ban-types
+// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
 function invokeHook(hook, ...args) {
     if (hook && typeof hook === 'function') {
         hook(...args);

package/dist/esm/renderingHostServer.js

@@ -45,7 +45,7 @@ export function startRenderingHostServer({ port = 0, hostname = 'localhost', hoo
  * @param {Function | undefined} hook
  * @param {...unknown} args
  */
-// eslint-disable-next-line @typescript-eslint/ban-types
+// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
 function invokeHook(hook, ...args) {
     if (hook && typeof hook === 'function') {
         hook(...args);

package/dist/esm/ssrMiddleware.js

@@ -80,7 +80,7 @@ export function respondWithError(res, errorValue) {
     }));
 }
 /**
- * @param {Object} dataWriter
+ * @param {object} dataWriter
  * @param {Buffer} dataWriter.output
  */
 export function onReadableStreamDataHandler(dataWriter) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-rendering-host",
-  "version": "22.3.0",
+  "version": "22.3.1-canary.11",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -11,10 +11,10 @@
     "test": "mocha --require ts-node/register/transpile-only \"./src/**/*.test.ts\"",
     "prepublishOnly": "npm run build",
     "coverage": "nyc npm test",
-    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-rendering-host src/index.ts --githubPages false"
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss-rendering-host src/index.ts --githubPages false"
   },
   "engines": {
-    "node": ">=20"
+    "node": ">=22"
   },
   "author": {
     "name": "Sitecore Corporation",
@@ -40,17 +40,18 @@
     "@types/express-serve-static-core": "^4.17.33",
     "@types/glob": "^8.0.1",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^20.14.2",
+    "@types/node": "^22.9.0",
     "@types/webpack": "5.28.5",
     "@types/webpack-dev-middleware": "2.0.5",
     "@types/webpack-dev-server": "3.1.7",
     "chai": "^4.3.0",
     "del-cli": "^5.0.0",
-    "eslint": "^8.33.0",
+    "eslint": "^8.56.0",
+    "eslint-plugin-jsdoc": "48.7.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
     "ts-node": "^10.9.1",
-    "typescript": "~4.9.5"
+    "typescript": "~5.6.3"
   },
   "description": "",
   "types": "types/index.d.ts",
@@ -66,5 +67,5 @@
     "types",
     "/global.d.ts"
   ],
-  "gitHead": "81b0239517966b6d0debdf6da3f12a98228c4d0c"
+  "gitHead": "e0fc3cbbe09cd16d73934faa4807de2867cd3126"
 }

package/types/defaultAppInvocationInfoResolver.d.ts

@@ -9,8 +9,7 @@ import { AppInvocationInfoResolver, JsonObject } from './ssrMiddleware';
  * `JSSAppName` is the `id` property of the JSON request body that is POSTed to the rendering host by Sitecore.
  *
  * `serverBundleName` is the name of the JavaScript file (typically a bundle) that contains the function for rendering your app.
- *
- * @param {string} [baseAppPath='./dist'] The base path to your JSS app(s), defaults to `./dist`
+ * @param {string} [baseAppPath] The base path to your JSS app(s), defaults to `./dist`
  * @returns {AppInvocationInfoResolver} resolver
  */
 export declare function getDefaultAppInvocationInfoResolver({ appPathResolver, baseAppPath, serverBundleName, }: {

package/types/ssrMiddleware.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { IncomingMessage, ServerResponse } from 'http';
 export type RenderCallback = (errorValue: Error, successValue?: string | {
     [key: string]: unknown;
@@ -38,7 +36,7 @@ export declare function readRequestBodyAsJson(request: IncomingMessage): Promise
  */
 export declare function respondWithError(res: ServerResponse, errorValue: Error): void;
 /**
- * @param {Object} dataWriter
+ * @param {object} dataWriter
  * @param {Buffer} dataWriter.output
  */
 export declare function onReadableStreamDataHandler(dataWriter: {