http-proxy-middleware 3.0.0-beta.1 → 3.0.0

package/README.md

@@ -2,7 +2,7 @@
 
 [![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/chimurai/http-proxy-middleware/ci.yml?branch=master&logo=github-actions&logoColor=white&style=flat-square)](https://github.com/chimurai/http-proxy-middleware/actions/workflows/ci.yml?query=branch%3Amaster)
 [![Coveralls](https://img.shields.io/coveralls/chimurai/http-proxy-middleware.svg?style=flat-square&logo=coveralls)](https://coveralls.io/r/chimurai/http-proxy-middleware)
-[![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/chimurai/http-proxy-middleware?logo=snyk&style=flat-square)](https://security.snyk.io/package/npm/http-proxy-middleware)
+[![Known Vulnerabilities](https://snyk.io/test/github/chimurai/http-proxy-middleware/badge.svg)](https://snyk.io/test/github/chimurai/http-proxy-middleware)
 [![npm](https://img.shields.io/npm/v/http-proxy-middleware?color=%23CC3534&style=flat-square&logo=npm)](https://www.npmjs.com/package/http-proxy-middleware)
 
 Node.js proxying made simple. Configure proxy middleware with ease for [connect](https://github.com/senchalabs/connect), [express](https://github.com/expressjs/express), [next.js](https://github.com/vercel/next.js) and [many more](#compatible-servers).
@@ -39,7 +39,7 @@ app.use(
   createProxyMiddleware({
     target: 'http://www.example.org/secret',
     changeOrigin: true,
-  })
+  }),
 );
 
 app.listen(3000);
@@ -61,7 +61,7 @@ app.use(
   createProxyMiddleware({
     target: 'http://www.example.org/api',
     changeOrigin: true,
-  })
+  }),
 );
 
 app.listen(3000);
@@ -164,7 +164,7 @@ app.use(
     target: 'http://www.example.org/api',
     changeOrigin: true,
     pathFilter: '/api/proxy-only-this-path',
-  })
+  }),
 );
 ```
 
@@ -489,7 +489,7 @@ The following options are provided by the underlying [http-proxy](https://github
         target: 'http://127.0.0.1:4003/',
         buffer: streamify(req.rawBody),
       },
-      next
+      next,
     );
   };
   ```

package/dist/errors.js

@@ -7,4 +7,4 @@ var ERRORS;
     ERRORS["ERR_CONTEXT_MATCHER_GENERIC"] = "[HPM] Invalid context. Expecting something like: \"/api\" or [\"/api\", \"/ajax\"]";
     ERRORS["ERR_CONTEXT_MATCHER_INVALID_ARRAY"] = "[HPM] Invalid pathFilter. Expecting something like: [\"/api\", \"/ajax\"] or [\"/api/**\", \"!**.html\"]";
     ERRORS["ERR_PATH_REWRITER_CONFIG"] = "[HPM] Invalid pathRewrite config. Expecting object with pathRewrite config or a rewrite function";
-})(ERRORS = exports.ERRORS || (exports.ERRORS = {}));
+})(ERRORS || (exports.ERRORS = ERRORS = {}));

package/dist/get-plugins.js

@@ -3,13 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPlugins = void 0;
 const default_1 = require("./plugins/default");
 function getPlugins(options) {
-    var _a, _b;
     // don't load default errorResponsePlugin if user has specified their own
-    const maybeErrorResponsePlugin = !!((_a = options.on) === null || _a === void 0 ? void 0 : _a.error) ? [] : [default_1.errorResponsePlugin];
+    const maybeErrorResponsePlugin = !!options.on?.error ? [] : [default_1.errorResponsePlugin];
     const defaultPlugins = !!options.ejectPlugins
         ? [] // no default plugins when ejecting
         : [default_1.debugProxyErrorsPlugin, default_1.proxyEventsPlugin, default_1.loggerPlugin, ...maybeErrorResponsePlugin];
-    const userPlugins = (_b = options.plugins) !== null && _b !== void 0 ? _b : [];
+    const userPlugins = options.plugins ?? [];
     return [...defaultPlugins, ...userPlugins];
 }
 exports.getPlugins = getPlugins;

package/dist/handlers/fix-request-body.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import type * as http from 'http';
-export declare type BodyParserLikeRequest = http.IncomingMessage & {
+export type BodyParserLikeRequest = http.IncomingMessage & {
     body: any;
 };
 /**

package/dist/handlers/response-interceptor.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import type * as http from 'http';
-declare type Interceptor<TReq = http.IncomingMessage, TRes = http.ServerResponse> = (buffer: Buffer, proxyRes: TReq, req: TReq, res: TRes) => Promise<Buffer | string>;
+type Interceptor<TReq = http.IncomingMessage, TRes = http.ServerResponse> = (buffer: Buffer, proxyRes: TReq, req: TReq, res: TRes) => Promise<Buffer | string>;
 /**
  * Intercept responses from upstream.
  * Automatically decompress (deflate, gzip, brotli).

package/dist/http-proxy-middleware.js

@@ -14,8 +14,7 @@ class HttpProxyMiddleware {
         this.wsInternalSubscribed = false;
         this.serverOnCloseSubscribed = false;
         // https://github.com/Microsoft/TypeScript/wiki/'this'-in-TypeScript#red-flags-for-this
-        this.middleware = async (req, res, next) => {
-            var _a, _b;
+        this.middleware = (async (req, res, next) => {
             if (this.shouldProxy(this.proxyOptions.pathFilter, req)) {
                 try {
                     const activeProxyOptions = await this.prepareProxyRequest(req);
@@ -37,7 +36,7 @@ class HttpProxyMiddleware {
              * req.socket: node >= 13
              * req.connection: node < 13 (Remove this when node 12/13 support is dropped)
              */
-            const server = (_b = (((_a = req.socket) !== null && _a !== void 0 ? _a : req.connection))) === null || _b === void 0 ? void 0 : _b.server;
+            const server = (req.socket ?? req.connection)?.server;
             if (server && !this.serverOnCloseSubscribed) {
                 server.on('close', () => {
                     (0, debug_1.Debug)('server close signal received: closing proxy server');
@@ -49,7 +48,7 @@ class HttpProxyMiddleware {
                 // use initial request to access the server object to subscribe to http upgrade event
                 this.catchUpgradeRequest(server);
             }
-        };
+        });
         this.catchUpgradeRequest = (server) => {
             if (!this.wsInternalSubscribed) {
                 (0, debug_1.Debug)('subscribing to server upgrade event');

package/dist/legacy/options-adapter.js

@@ -18,12 +18,15 @@ const proxyEventMap = {
  * Convert {@link LegacyOptions legacy Options} to new {@link Options}
  */
 function legacyOptionsAdapter(legacyContext, legacyOptions) {
-    let options;
+    let options = {};
     let logger;
     // https://github.com/chimurai/http-proxy-middleware/pull/716
     if (typeof legacyContext === 'string' && !!url.parse(legacyContext).host) {
         throw new Error(`Shorthand syntax is removed from legacyCreateProxyMiddleware().
-      Please use "legacyCreateProxyMiddleware({ target: 'http://www.example.org' })" instead.`);
+      Please use "legacyCreateProxyMiddleware({ target: 'http://www.example.org' })" instead.
+
+      More details: https://github.com/chimurai/http-proxy-middleware/blob/master/MIGRATION.md#removed-shorthand-usage
+      `);
     }
     // detect old "context" argument and convert to "options.pathFilter"
     // https://github.com/chimurai/http-proxy-middleware/pull/722/files#diff-a2a171449d862fe29692ce031981047d7ab755ae7f84c707aef80701b3ea0c80L4
@@ -37,13 +40,16 @@ function legacyOptionsAdapter(legacyContext, legacyOptions) {
         pathFilter: '${legacyContext}',
       }
 
-      More details: https://github.com/chimurai/http-proxy-middleware/blob/master/MIGRATION.md
+      More details: https://github.com/chimurai/http-proxy-middleware/blob/master/MIGRATION.md#removed-context-argument
       `);
     }
     else if (legacyContext && !legacyOptions) {
         options = { ...legacyContext };
         logger = getLegacyLogger(options);
     }
+    else {
+        logger = getLegacyLogger({});
+    }
     // map old event names to new event names
     // https://github.com/chimurai/http-proxy-middleware/pull/745/files#diff-c54113cf61ec99691748a3890bfbeb00e10efb3f0a76f03a0fd9ec49072e410aL48-L53
     Object.entries(proxyEventMap).forEach(([legacyEventName, proxyEventName]) => {
@@ -59,7 +65,7 @@ function legacyOptionsAdapter(legacyContext, legacyOptions) {
           },
         }
 
-        More details: https://github.com/chimurai/http-proxy-middleware/blob/master/MIGRATION.md
+        More details: https://github.com/chimurai/http-proxy-middleware/blob/master/MIGRATION.md#refactored-proxy-events
         `);
         }
     });
@@ -77,7 +83,7 @@ function legacyOptionsAdapter(legacyContext, legacyOptions) {
         logger: console,
       }
 
-      More details: https://github.com/chimurai/http-proxy-middleware/blob/master/MIGRATION.md
+      More details: https://github.com/chimurai/http-proxy-middleware/blob/master/MIGRATION.md#removed-logprovider-and-loglevel-options
       `);
     }
     return options;

package/dist/path-filter.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="node" />
 import type { Filter } from './types';
 import type * as http from 'http';
-export declare function matchPathFilter<TReq = http.IncomingMessage>(pathFilter: Filter<TReq>, uri: string, req: http.IncomingMessage): boolean;
+export declare function matchPathFilter<TReq = http.IncomingMessage>(pathFilter: Filter<TReq> | undefined, uri: string | undefined, req: http.IncomingMessage): boolean;

package/dist/path-filter.js

@@ -39,7 +39,7 @@ exports.matchPathFilter = matchPathFilter;
  */
 function matchSingleStringPath(pathFilter, uri) {
     const pathname = getUrlPathName(uri);
-    return pathname.indexOf(pathFilter) === 0;
+    return pathname?.indexOf(pathFilter) === 0;
 }
 function matchSingleGlobPath(pattern, uri) {
     const pathname = getUrlPathName(uri);

package/dist/plugins/default/error-response-plugin.js

@@ -8,7 +8,7 @@ const errorResponsePlugin = (proxyServer, options) => {
         if (!req && !res) {
             throw err; // "Error: Must provide a proper URL as target"
         }
-        if (res.writeHead && !res.headersSent) {
+        if ('writeHead' in res && !res.headersSent) {
             const statusCode = (0, status_code_1.getStatusCode)(err.code);
             res.writeHead(statusCode);
         }

package/dist/plugins/default/logger-plugin.js

@@ -5,10 +5,9 @@ const logger_1 = require("../../logger");
 const loggerPlugin = (proxyServer, options) => {
     const logger = (0, logger_1.getLogger)(options);
     proxyServer.on('error', (err, req, res, target) => {
-        var _a;
-        const hostname = (_a = req === null || req === void 0 ? void 0 : req.headers) === null || _a === void 0 ? void 0 : _a.host;
-        const requestHref = `${hostname}${req === null || req === void 0 ? void 0 : req.url}`;
-        const targetHref = `${target === null || target === void 0 ? void 0 : target.href}`; // target is undefined when websocket errors
+        const hostname = req?.headers?.host;
+        const requestHref = `${hostname}${req?.url}`;
+        const targetHref = `${target?.href}`; // target is undefined when websocket errors
         const errorMessage = '[HPM] Error occurred while proxying request %s to %s [%s] (%s)';
         const errReference = 'https://nodejs.org/api/errors.html#errors_common_system_errors'; // link to Node Common Systems Errors page
         logger.error(errorMessage, requestHref, targetHref, err.code || err, errReference);
@@ -21,10 +20,9 @@ const loggerPlugin = (proxyServer, options) => {
      * ```
      */
     proxyServer.on('proxyRes', (proxyRes, req, res) => {
-        var _a;
         // BrowserSync uses req.originalUrl
         // Next.js doesn't have req.baseUrl
-        const originalUrl = (_a = req.originalUrl) !== null && _a !== void 0 ? _a : `${req.baseUrl || ''}${req.url}`;
+        const originalUrl = req.originalUrl ?? `${req.baseUrl || ''}${req.url}`;
         const exchange = `[HPM] ${req.method} ${originalUrl} -> ${proxyRes.req.protocol}//${proxyRes.req.host}${proxyRes.req.path} [${proxyRes.statusCode}]`;
         logger.info(exchange);
     });

package/dist/types.d.ts

@@ -5,15 +5,16 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import type * as http from 'http';
 import type * as httpProxy from 'http-proxy';
 import type * as net from 'net';
-export declare type NextFunction<T = (err?: any) => void> = T;
+export type NextFunction<T = (err?: any) => void> = T;
 export interface RequestHandler<TReq = http.IncomingMessage, TRes = http.ServerResponse, TNext = NextFunction> {
     (req: TReq, res: TRes, next?: TNext): void | Promise<void>;
-    upgrade?: (req: http.IncomingMessage, socket: net.Socket, head: any) => void;
+    upgrade: (req: http.IncomingMessage, socket: net.Socket, head: Buffer) => void;
 }
-export declare type Filter<TReq = http.IncomingMessage> = string | string[] | ((pathname: string, req: TReq) => boolean);
+export type Filter<TReq = http.IncomingMessage> = string | string[] | ((pathname: string, req: TReq) => boolean);
 export interface Plugin<TReq = http.IncomingMessage, TRes = http.ServerResponse> {
     (proxyServer: httpProxy<TReq, TRes>, options: Options<TReq, TRes>): void;
 }
@@ -28,7 +29,7 @@ export interface OnProxyEvent<TReq = http.IncomingMessage, TRes = http.ServerRes
     end?: httpProxy.EndCallback<TReq, TRes>;
     econnreset?: httpProxy.EconnresetCallback<Error, TReq, TRes>;
 }
-export declare type Logger = Pick<Console, 'info' | 'warn' | 'error'>;
+export type Logger = Pick<Console, 'info' | 'warn' | 'error'>;
 export interface Options<TReq = http.IncomingMessage, TRes = http.ServerResponse> extends httpProxy.ServerOptions {
     /**
      * Narrow down requests to proxy or not.
@@ -52,7 +53,7 @@ export interface Options<TReq = http.IncomingMessage, TRes = http.ServerResponse
      */
     pathRewrite?: {
         [regexp: string]: string;
-    } | ((path: string, req: TReq) => string) | ((path: string, req: TReq) => Promise<string>);
+    } | ((path: string, req: TReq) => string | undefined) | ((path: string, req: TReq) => Promise<string>);
     /**
      * Access the internal http-proxy server instance to customize behavior
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-proxy-middleware",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0",
   "description": "The one-liner node.js proxy middleware for connect, express, next.js and more",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,7 +18,7 @@
     "build": "tsc --build",
     "test": "jest",
     "coverage": "jest --coverage",
-    "prepare": "husky install",
+    "prepare": "husky",
     "prepack": "yarn clean && yarn test && yarn build",
     "spellcheck": "npx --yes cspell --show-context --show-suggestions '**/*.*'"
   },
@@ -51,36 +51,36 @@
   },
   "homepage": "https://github.com/chimurai/http-proxy-middleware#readme",
   "devDependencies": {
-    "@commitlint/cli": "17.4.4",
-    "@commitlint/config-conventional": "17.4.4",
-    "@types/debug": "4.1.7",
-    "@types/express": "4.17.17",
-    "@types/is-glob": "4.0.2",
-    "@types/jest": "29.4.0",
-    "@types/micromatch": "4.0.2",
-    "@types/node": "18.14.5",
+    "@commitlint/cli": "17.7.1",
+    "@commitlint/config-conventional": "17.7.0",
+    "@types/debug": "4.1.12",
+    "@types/express": "4.17.21",
+    "@types/is-glob": "4.0.4",
+    "@types/jest": "29.5.12",
+    "@types/micromatch": "4.0.6",
+    "@types/node": "20.11.30",
     "@types/supertest": "2.0.12",
-    "@types/ws": "8.5.4",
-    "@typescript-eslint/eslint-plugin": "5.54.0",
-    "@typescript-eslint/parser": "5.54.0",
+    "@types/ws": "8.5.10",
+    "@typescript-eslint/eslint-plugin": "7.4.0",
+    "@typescript-eslint/parser": "7.4.0",
     "body-parser": "1.20.2",
-    "browser-sync": "2.28.1",
+    "browser-sync": "3.0.2",
     "connect": "3.7.0",
-    "eslint": "8.35.0",
-    "eslint-config-prettier": "8.6.0",
-    "eslint-plugin-prettier": "4.2.1",
-    "express": "4.18.2",
+    "eslint": "8.57.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-prettier": "5.1.3",
+    "express": "4.19.2",
     "get-port": "5.1.1",
-    "husky": "8.0.3",
-    "jest": "29.4.3",
-    "lint-staged": "13.1.2",
-    "mockttp": "3.7.0",
+    "husky": "9.0.11",
+    "jest": "29.7.0",
+    "lint-staged": "15.2.2",
+    "mockttp": "3.10.1",
     "open": "8.4.2",
-    "prettier": "2.8.4",
-    "supertest": "6.3.3",
-    "ts-jest": "29.0.5",
-    "typescript": "4.9.5",
-    "ws": "8.12.1"
+    "prettier": "3.2.5",
+    "supertest": "6.3.4",
+    "ts-jest": "29.1.2",
+    "typescript": "5.4.3",
+    "ws": "8.16.0"
   },
   "dependencies": {
     "@types/http-proxy": "^1.17.10",
@@ -91,7 +91,7 @@
     "micromatch": "^4.0.5"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
   },
   "commitlint": {
     "extends": [