@sitecore-jss/sitecore-jss-proxy 21.1.0-canary.99 → 21.1.1

package/README.md

@@ -2,9 +2,7 @@
 
 This module is provided as a part of Sitecore JavaScript Rendering SDK (JSS). It contains the headless-mode SSR proxy implementation.
 
-<!---
-@TODO: Update to version 20.0.0 docs before release
--->
-[Documentation](https://doc.sitecore.com/xp/en/developers/hd/190/sitecore-headless-development/server-side-render-jss-apps-headlessly-using-the-jss-proxy.html)
 
-[API reference documentation](/ref-docs/sitecore-jss-proxy/).
+[Documentation (Experience Platform)](https://doc.sitecore.com/xp/en/developers/hd/210/sitecore-headless-development/server-side-render-jss-apps-headlessly-using-the-jss-proxy.html)
+
+[API reference documentation](/ref-docs/sitecore-jss-proxy/)

package/dist/cjs/index.js

@@ -13,7 +13,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.rewriteRequestPath = exports.removeEmptyAnalyticsCookie = void 0;
-const http_proxy_middleware_1 = __importDefault(require("http-proxy-middleware"));
+const http_proxy_middleware_1 = require("http-proxy-middleware");
 const http_status_codes_1 = __importDefault(require("http-status-codes"));
 const set_cookie_parser_1 = __importDefault(require("set-cookie-parser"));
 const zlib_1 = __importDefault(require("zlib")); // node.js standard lib
@@ -237,8 +237,8 @@ function renderAppToResponse(proxyResponse, request, serverResponse, renderer, c
 }
 /**
  * @param {IncomingMessage} proxyResponse
- * @param {IncomingMessage} request
- * @param {ServerResponse} serverResponse
+ * @param {Request} request
+ * @param {Response} serverResponse
  * @param {AppRenderer} renderer
  * @param {ProxyConfig} config
  */
@@ -263,7 +263,7 @@ function handleProxyResponse(proxyResponse, request, serverResponse, renderer, c
 }
 /**
  * @param {string} reqPath
- * @param {IncomingMessage} req
+ * @param {Request} req
  * @param {ProxyConfig} config
  * @param {RouteUrlParser} parseRouteUrl
  */
@@ -371,12 +371,13 @@ function isUrlIgnored(originalUrl, config, noDebug = false) {
 }
 /**
  * @param {ClientRequest} proxyReq
- * @param {IncomingMessage} req
- * @param {ServerResponse} res
+ * @param {Request} req
+ * @param {Response} res
+ * @param {ServerOptions} options
  * @param {ProxyConfig} config
  * @param {Function} customOnProxyReq
  */
-function handleProxyRequest(proxyReq, req, res, config, customOnProxyReq) {
+function handleProxyRequest(proxyReq, req, res, options, config, customOnProxyReq) {
     // if a HEAD request, we still need to issue a GET so we can return accurate headers
     if (proxyReq.method === 'HEAD' &&
         !isUrlIgnored(req.originalUrl, config, true)) {
@@ -387,7 +388,7 @@ function handleProxyRequest(proxyReq, req, res, config, customOnProxyReq) {
     }
     // invoke custom onProxyReq
     if (customOnProxyReq) {
-        customOnProxyReq(proxyReq, req, res);
+        customOnProxyReq(proxyReq, req, res, options);
     }
 }
 /**
@@ -408,7 +409,7 @@ function createOptions(renderer, config, parseRouteUrl) {
         console.log('DEBUG: Final proxy config', config);
     }
     const customOnProxyReq = (_a = config.proxyOptions) === null || _a === void 0 ? void 0 : _a.onProxyReq;
-    return Object.assign(Object.assign({}, config.proxyOptions), { target: config.apiHost, changeOrigin: true, ws: config.ws || false, pathRewrite: (reqPath, req) => rewriteRequestPath(reqPath, req, config, parseRouteUrl), logLevel: config.debug ? 'debug' : 'info', onProxyReq: (proxyReq, req, res) => handleProxyRequest(proxyReq, req, res, config, customOnProxyReq), onProxyRes: (proxyRes, req, res) => handleProxyResponse(proxyRes, req, res, renderer, config) });
+    return Object.assign(Object.assign({}, config.proxyOptions), { target: config.apiHost, changeOrigin: true, ws: config.ws || false, pathRewrite: (reqPath, req) => rewriteRequestPath(reqPath, req, config, parseRouteUrl), logLevel: config.debug ? 'debug' : 'info', onProxyReq: (proxyReq, req, res, options) => handleProxyRequest(proxyReq, req, res, options, config, customOnProxyReq), onProxyRes: (proxyRes, req, res) => handleProxyResponse(proxyRes, req, res, renderer, config) });
 }
 /**
  * @param {AppRenderer} renderer
@@ -417,6 +418,6 @@ function createOptions(renderer, config, parseRouteUrl) {
  */
 function scProxy(renderer, config, parseRouteUrl) {
     const options = createOptions(renderer, config, parseRouteUrl);
-    return (0, http_proxy_middleware_1.default)(options);
+    return (0, http_proxy_middleware_1.createProxyMiddleware)(options);
 }
 exports.default = scProxy;

package/dist/esm/index.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import proxy from 'http-proxy-middleware';
+import { createProxyMiddleware } from 'http-proxy-middleware';
 import HttpStatus from 'http-status-codes';
 import setCookieParser from 'set-cookie-parser';
 import zlib from 'zlib'; // node.js standard lib
@@ -230,8 +230,8 @@ function renderAppToResponse(proxyResponse, request, serverResponse, renderer, c
 }
 /**
  * @param {IncomingMessage} proxyResponse
- * @param {IncomingMessage} request
- * @param {ServerResponse} serverResponse
+ * @param {Request} request
+ * @param {Response} serverResponse
  * @param {AppRenderer} renderer
  * @param {ProxyConfig} config
  */
@@ -256,7 +256,7 @@ function handleProxyResponse(proxyResponse, request, serverResponse, renderer, c
 }
 /**
  * @param {string} reqPath
- * @param {IncomingMessage} req
+ * @param {Request} req
  * @param {ProxyConfig} config
  * @param {RouteUrlParser} parseRouteUrl
  */
@@ -363,12 +363,13 @@ function isUrlIgnored(originalUrl, config, noDebug = false) {
 }
 /**
  * @param {ClientRequest} proxyReq
- * @param {IncomingMessage} req
- * @param {ServerResponse} res
+ * @param {Request} req
+ * @param {Response} res
+ * @param {ServerOptions} options
  * @param {ProxyConfig} config
  * @param {Function} customOnProxyReq
  */
-function handleProxyRequest(proxyReq, req, res, config, customOnProxyReq) {
+function handleProxyRequest(proxyReq, req, res, options, config, customOnProxyReq) {
     // if a HEAD request, we still need to issue a GET so we can return accurate headers
     if (proxyReq.method === 'HEAD' &&
         !isUrlIgnored(req.originalUrl, config, true)) {
@@ -379,7 +380,7 @@ function handleProxyRequest(proxyReq, req, res, config, customOnProxyReq) {
     }
     // invoke custom onProxyReq
     if (customOnProxyReq) {
-        customOnProxyReq(proxyReq, req, res);
+        customOnProxyReq(proxyReq, req, res, options);
     }
 }
 /**
@@ -400,7 +401,7 @@ function createOptions(renderer, config, parseRouteUrl) {
         console.log('DEBUG: Final proxy config', config);
     }
     const customOnProxyReq = (_a = config.proxyOptions) === null || _a === void 0 ? void 0 : _a.onProxyReq;
-    return Object.assign(Object.assign({}, config.proxyOptions), { target: config.apiHost, changeOrigin: true, ws: config.ws || false, pathRewrite: (reqPath, req) => rewriteRequestPath(reqPath, req, config, parseRouteUrl), logLevel: config.debug ? 'debug' : 'info', onProxyReq: (proxyReq, req, res) => handleProxyRequest(proxyReq, req, res, config, customOnProxyReq), onProxyRes: (proxyRes, req, res) => handleProxyResponse(proxyRes, req, res, renderer, config) });
+    return Object.assign(Object.assign({}, config.proxyOptions), { target: config.apiHost, changeOrigin: true, ws: config.ws || false, pathRewrite: (reqPath, req) => rewriteRequestPath(reqPath, req, config, parseRouteUrl), logLevel: config.debug ? 'debug' : 'info', onProxyReq: (proxyReq, req, res, options) => handleProxyRequest(proxyReq, req, res, options, config, customOnProxyReq), onProxyRes: (proxyRes, req, res) => handleProxyResponse(proxyRes, req, res, renderer, config) });
 }
 /**
  * @param {AppRenderer} renderer
@@ -409,5 +410,5 @@ function createOptions(renderer, config, parseRouteUrl) {
  */
 export default function scProxy(renderer, config, parseRouteUrl) {
     const options = createOptions(renderer, config, parseRouteUrl);
-    return proxy(options);
+    return createProxyMiddleware(options);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-proxy",
-  "version": "21.1.0-canary.99",
+  "version": "21.1.1",
   "description": "Proxy middleware for express.js server.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -28,15 +28,15 @@
     "url": "https://github.com/sitecore/jss/issues"
   },
   "dependencies": {
-    "http-proxy-middleware": "^0.20.0",
+    "http-proxy-middleware": "^2.0.6",
     "http-status-codes": "^2.2.0",
     "set-cookie-parser": "^2.5.1"
   },
   "devDependencies": {
     "@types/chai": "^4.3.4",
-    "@types/http-proxy-middleware": "^0.19.3",
+    "@types/express": "^4.17.17",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.11.18",
+    "@types/node": "^18.14.2",
     "@types/set-cookie-parser": "^2.4.2",
     "chai": "^4.3.7",
     "del-cli": "^5.0.0",
@@ -47,7 +47,7 @@
     "typescript": "~4.9.5"
   },
   "types": "types/index.d.ts",
-  "gitHead": "5b1755d4be55645818169d278dd204543d1351d8",
+  "gitHead": "ae9d7fc994fa11061b5a164ff6a86b3ccf845a4c",
   "files": [
     "dist",
     "types"

package/types/ProxyConfig.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="node" />
 import { IncomingMessage, ServerResponse, Agent } from 'http';
 import { Agent as HttpsAgent } from 'https';
-import { Config as HttpProxyConfig } from 'http-proxy-middleware';
+import { Options } from 'http-proxy-middleware';
 import { AppRenderer } from './AppRenderer';
 import { RenderResponse } from './RenderResponse';
 import { RouteUrlParser } from './RouteUrlParser';
@@ -52,7 +52,7 @@ export interface ProxyConfig {
      */
     pathRewriteExcludePredicate?: (originalUrl: string) => boolean;
     /** Configure `http-proxy-middleware` */
-    proxyOptions?: HttpProxyConfig;
+    proxyOptions?: Options;
     /** Enables or disables proxy diagnostics in console.log (disable for production or get bad performance) */
     debug?: boolean;
     /** Callback when an exception is thrown during SSR; decides what to send back to client (500 errors) */

package/types/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
-/// <reference types="connect" />
 import { IncomingMessage } from 'http';
+import { Request } from 'express';
 import { AppRenderer } from './AppRenderer';
 import { ProxyConfig, ServerBundle } from './ProxyConfig';
 import { RouteUrlParser } from './RouteUrlParser';
@@ -16,15 +16,15 @@ export interface ProxyIncomingMessage extends IncomingMessage {
 export declare const removeEmptyAnalyticsCookie: (proxyResponse: IncomingMessage) => void;
 /**
  * @param {string} reqPath
- * @param {IncomingMessage} req
+ * @param {Request} req
  * @param {ProxyConfig} config
  * @param {RouteUrlParser} parseRouteUrl
  */
-export declare function rewriteRequestPath(reqPath: string, req: IncomingMessage, config: ProxyConfig, parseRouteUrl?: RouteUrlParser): string;
+export declare function rewriteRequestPath(reqPath: string, req: Request, config: ProxyConfig, parseRouteUrl?: RouteUrlParser): string;
 /**
  * @param {AppRenderer} renderer
  * @param {ProxyConfig} config
  * @param {RouteUrlParser} parseRouteUrl
  */
-export default function scProxy(renderer: AppRenderer, config: ProxyConfig, parseRouteUrl: RouteUrlParser): import("connect").NextHandleFunction;
+export default function scProxy(renderer: AppRenderer, config: ProxyConfig, parseRouteUrl: RouteUrlParser): import("http-proxy-middleware").RequestHandler;
 export { ProxyConfig, ServerBundle };