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

package/README.md

@@ -26,48 +26,29 @@ Proxy `/api` requests to `http://www.example.org`
 
 :bulb: **Tip:** Set the option `changeOrigin` to `true` for [name-based virtual hosted sites](http://en.wikipedia.org/wiki/Virtual_hosting#Name-based).
 
-```javascript
-// javascript
-
-const express = require('express');
-const { createProxyMiddleware } = require('http-proxy-middleware');
-
-const app = express();
-
-app.use(
-  '/api',
-  createProxyMiddleware({
-    target: 'http://www.example.org/secret',
-    changeOrigin: true,
-  }),
-);
-
-app.listen(3000);
-
-// proxy and change the base path from "/api" to "/secret"
-// http://127.0.0.1:3000/api/foo/bar -> http://www.example.org/secret/foo/bar
-```
-
 ```typescript
 // typescript
 
 import * as express from 'express';
-import { createProxyMiddleware, Filter, Options, RequestHandler } from 'http-proxy-middleware';
+import type { Request, Response, NextFunction } from 'express';
+
+import { createProxyMiddleware } from 'http-proxy-middleware';
+import type { Filter, Options, RequestHandler } from 'http-proxy-middleware';
 
 const app = express();
 
-app.use(
-  '/api',
-  createProxyMiddleware({
+const proxyMiddleware = createProxyMiddleware<Request, Response>({
     target: 'http://www.example.org/api',
     changeOrigin: true,
   }),
-);
+
+app.use('/api', proxyMiddleware);
 
 app.listen(3000);
 
 // proxy and keep the same base path "/api"
 // http://127.0.0.1:3000/api/foo/bar -> http://www.example.org/api/foo/bar
+
 ```
 
 _All_ `http-proxy` [options](https://github.com/nodejitsu/node-http-proxy#options) can be used, along with some extra `http-proxy-middleware` [options](#options).

package/dist/configuration.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyConfig = void 0;
+exports.verifyConfig = verifyConfig;
 const errors_1 = require("./errors");
 function verifyConfig(options) {
     if (!options.target && !options.router) {
         throw new Error(errors_1.ERRORS.ERR_CONFIG_FACTORY_TARGET_MISSING);
     }
 }
-exports.verifyConfig = verifyConfig;

package/dist/errors.d.ts

@@ -1,6 +1,6 @@
 export declare enum ERRORS {
     ERR_CONFIG_FACTORY_TARGET_MISSING = "[HPM] Missing \"target\" option. Example: {target: \"http://www.example.org\"}",
-    ERR_CONTEXT_MATCHER_GENERIC = "[HPM] Invalid context. Expecting something like: \"/api\" or [\"/api\", \"/ajax\"]",
-    ERR_CONTEXT_MATCHER_INVALID_ARRAY = "[HPM] Invalid pathFilter. Expecting something like: [\"/api\", \"/ajax\"] or [\"/api/**\", \"!**.html\"]",
+    ERR_CONTEXT_MATCHER_GENERIC = "[HPM] Invalid pathFilter. Expecting something like: \"/api\" or [\"/api\", \"/ajax\"]",
+    ERR_CONTEXT_MATCHER_INVALID_ARRAY = "[HPM] Invalid pathFilter. Plain paths (e.g. \"/api\") can not be mixed with globs (e.g. \"/api/**\"). Expecting something like: [\"/api\", \"/ajax\"] or [\"/api/**\", \"!**.html\"].",
     ERR_PATH_REWRITER_CONFIG = "[HPM] Invalid pathRewrite config. Expecting object with pathRewrite config or a rewrite function"
 }

package/dist/errors.js

@@ -4,7 +4,7 @@ exports.ERRORS = void 0;
 var ERRORS;
 (function (ERRORS) {
     ERRORS["ERR_CONFIG_FACTORY_TARGET_MISSING"] = "[HPM] Missing \"target\" option. Example: {target: \"http://www.example.org\"}";
-    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_CONTEXT_MATCHER_GENERIC"] = "[HPM] Invalid pathFilter. Expecting something like: \"/api\" or [\"/api\", \"/ajax\"]";
+    ERRORS["ERR_CONTEXT_MATCHER_INVALID_ARRAY"] = "[HPM] Invalid pathFilter. Plain paths (e.g. \"/api\") can not be mixed with globs (e.g. \"/api/**\"). 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 = ERRORS = {}));

package/dist/factory.d.ts

@@ -0,0 +1,3 @@
+import type { Options, RequestHandler, NextFunction } from './types';
+import type * as http from 'http';
+export declare function createProxyMiddleware<TReq = http.IncomingMessage, TRes = http.ServerResponse, TNext = NextFunction>(options: Options<TReq, TRes>): RequestHandler<TReq, TRes, TNext>;

package/dist/factory.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createProxyMiddleware = createProxyMiddleware;
+const http_proxy_middleware_1 = require("./http-proxy-middleware");
+function createProxyMiddleware(options) {
+    const { middleware } = new http_proxy_middleware_1.HttpProxyMiddleware(options);
+    return middleware;
+}

package/dist/get-plugins.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPlugins = void 0;
+exports.getPlugins = getPlugins;
 const default_1 = require("./plugins/default");
 function getPlugins(options) {
     // don't load default errorResponsePlugin if user has specified their own
@@ -11,4 +11,3 @@ function getPlugins(options) {
     const userPlugins = options.plugins ?? [];
     return [...defaultPlugins, ...userPlugins];
 }
-exports.getPlugins = getPlugins;

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

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

package/dist/handlers/fix-request-body.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fixRequestBody = void 0;
+exports.fixRequestBody = fixRequestBody;
 const querystring = require("querystring");
 /**
  * Fix proxied body if bodyParser is involved.
@@ -16,11 +16,10 @@ function fixRequestBody(proxyReq, req) {
         proxyReq.setHeader('Content-Length', Buffer.byteLength(bodyData));
         proxyReq.write(bodyData);
     };
-    if (contentType && contentType.includes('application/json')) {
+    if (contentType && (contentType.includes('application/json') || contentType.includes('+json'))) {
         writeBody(JSON.stringify(requestBody));
     }
     if (contentType && contentType.includes('application/x-www-form-urlencoded')) {
         writeBody(querystring.stringify(requestBody));
     }
 }
-exports.fixRequestBody = fixRequestBody;

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

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import type * as http from 'http';
 type Interceptor<TReq = http.IncomingMessage, TRes = http.ServerResponse> = (buffer: Buffer, proxyRes: TReq, req: TReq, res: TRes) => Promise<Buffer | string>;
 /**

package/dist/handlers/response-interceptor.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.responseInterceptor = void 0;
+exports.responseInterceptor = responseInterceptor;
 const zlib = require("zlib");
 const debug_1 = require("../debug");
 const function_1 = require("../utils/function");
@@ -39,7 +39,6 @@ function responseInterceptor(interceptor) {
         });
     };
 }
-exports.responseInterceptor = responseInterceptor;
 /**
  * Streaming decompression of proxy response
  * source: https://github.com/apache/superset/blob/9773aba522e957ed9423045ca153219638a85d2f/superset-frontend/webpack.proxy-config.js#L116

package/dist/index.d.ts

@@ -1,7 +1,4 @@
-/// <reference types="node" />
-import type { Options, RequestHandler, NextFunction } from './types';
-import type * as http from 'http';
-export declare function createProxyMiddleware<TReq = http.IncomingMessage, TRes = http.ServerResponse, TNext = NextFunction>(options: Options<TReq, TRes>): RequestHandler<TReq, TRes, TNext>;
+export * from './factory';
 export * from './handlers';
 export type { Filter, Options, RequestHandler } from './types';
 /**

package/dist/index.js

@@ -14,13 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createProxyMiddleware = void 0;
-const http_proxy_middleware_1 = require("./http-proxy-middleware");
-function createProxyMiddleware(options) {
-    const { middleware } = new http_proxy_middleware_1.HttpProxyMiddleware(options);
-    return middleware;
-}
-exports.createProxyMiddleware = createProxyMiddleware;
+__exportStar(require("./factory"), exports);
 __exportStar(require("./handlers"), exports);
 /**
  * Default plugins

package/dist/legacy/create-proxy-middleware.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Filter, RequestHandler } from '../types';
 import { LegacyOptions } from './types';
 import type * as http from 'http';

package/dist/legacy/create-proxy-middleware.js

@@ -1,17 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.legacyCreateProxyMiddleware = void 0;
-const __1 = require("..");
+exports.legacyCreateProxyMiddleware = legacyCreateProxyMiddleware;
+const factory_1 = require("../factory");
 const debug_1 = require("../debug");
 const options_adapter_1 = require("./options-adapter");
 const debug = debug_1.Debug.extend('legacy-create-proxy-middleware');
 function legacyCreateProxyMiddleware(legacyContext, legacyOptions) {
     debug('init');
     const options = (0, options_adapter_1.legacyOptionsAdapter)(legacyContext, legacyOptions);
-    const proxyMiddleware = (0, __1.createProxyMiddleware)(options);
+    const proxyMiddleware = (0, factory_1.createProxyMiddleware)(options);
     // https://github.com/chimurai/http-proxy-middleware/pull/731/files#diff-07e6ad10bda0df091b737caed42767657cd0bd74a01246a1a0b7ab59c0f6e977L118
     debug('add marker for patching req.url (old behavior)');
     proxyMiddleware.__LEGACY_HTTP_PROXY_MIDDLEWARE__ = true;
     return proxyMiddleware;
 }
-exports.legacyCreateProxyMiddleware = legacyCreateProxyMiddleware;

package/dist/legacy/options-adapter.d.ts

@@ -1,4 +1,4 @@
-import { Filter, Options } from '..';
+import { Filter, Options } from '../types';
 import { LegacyOptions } from './types';
 /**
  * Convert {@link LegacyOptions legacy Options} to new {@link Options}

package/dist/legacy/options-adapter.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.legacyOptionsAdapter = void 0;
+exports.legacyOptionsAdapter = legacyOptionsAdapter;
 const url = require("url");
 const debug_1 = require("../debug");
 const logger_1 = require("../logger");
@@ -88,7 +88,6 @@ function legacyOptionsAdapter(legacyContext, legacyOptions) {
     }
     return options;
 }
-exports.legacyOptionsAdapter = legacyOptionsAdapter;
 function getLegacyLogger(options) {
     const legacyLogger = options.logProvider && options.logProvider();
     if (legacyLogger) {

package/dist/legacy/types.d.ts

@@ -1,6 +1,5 @@
-/// <reference types="node" />
 import type * as http from 'http';
-import { Options } from '..';
+import { Options } from '../types';
 /**
  * @deprecated
  *

package/dist/logger.js

@@ -1,7 +1,7 @@
 "use strict";
 /* eslint-disable @typescript-eslint/no-empty-function */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLogger = void 0;
+exports.getLogger = getLogger;
 /**
  * Compatibility matrix
  *
@@ -23,4 +23,3 @@ const noopLogger = {
 function getLogger(options) {
     return options.logger || noopLogger;
 }
-exports.getLogger = getLogger;

package/dist/path-filter.d.ts

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

package/dist/path-filter.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.matchPathFilter = void 0;
+exports.matchPathFilter = matchPathFilter;
 const isGlob = require("is-glob");
 const micromatch = require("micromatch");
 const url = require("url");
@@ -31,7 +31,6 @@ function matchPathFilter(pathFilter = '/', uri, req) {
     }
     throw new Error(errors_1.ERRORS.ERR_CONTEXT_MATCHER_GENERIC);
 }
-exports.matchPathFilter = matchPathFilter;
 /**
  * @param  {String} pathFilter '/api'
  * @param  {String} uri     'http://example.org/api/b/c/d.html'

package/dist/path-rewriter.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPathRewriter = void 0;
+exports.createPathRewriter = createPathRewriter;
 const isPlainObj = require("is-plain-obj");
 const errors_1 = require("./errors");
 const debug_1 = require("./debug");
@@ -36,7 +36,6 @@ function createPathRewriter(rewriteConfig) {
         return result;
     }
 }
-exports.createPathRewriter = createPathRewriter;
 function isValidRewriteConfig(rewriteConfig) {
     if (typeof rewriteConfig === 'function') {
         return true;

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

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loggerPlugin = void 0;
+const url_1 = require("url");
 const logger_1 = require("../../logger");
+const logger_plugin_1 = require("../../utils/logger-plugin");
 const loggerPlugin = (proxyServer, options) => {
     const logger = (0, logger_1.getLogger)(options);
     proxyServer.on('error', (err, req, res, target) => {
@@ -23,7 +25,19 @@ const loggerPlugin = (proxyServer, options) => {
         // BrowserSync uses req.originalUrl
         // Next.js doesn't have req.baseUrl
         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}]`;
+        // construct targetUrl
+        const port = (0, logger_plugin_1.getPort)(proxyRes.req?.agent?.sockets);
+        const obj = {
+            protocol: proxyRes.req.protocol,
+            host: proxyRes.req.host,
+            pathname: proxyRes.req.path,
+        };
+        const target = new url_1.URL(`${obj.protocol}//${obj.host}${obj.pathname}`);
+        if (port) {
+            target.port = port;
+        }
+        const targetUrl = target.toString();
+        const exchange = `[HPM] ${req.method} ${originalUrl} -> ${targetUrl} [${proxyRes.statusCode}]`;
         logger.info(exchange);
     });
     /**

package/dist/router.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTarget = void 0;
+exports.getTarget = getTarget;
 const isPlainObj = require("is-plain-obj");
 const debug_1 = require("./debug");
 const debug = debug_1.Debug.extend('router');
@@ -15,7 +15,6 @@ async function getTarget(req, config) {
     }
     return newTarget;
 }
-exports.getTarget = getTarget;
 function getTargetFromProxyTable(req, table) {
     let result;
     const host = req.headers.host;

package/dist/status-code.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStatusCode = void 0;
+exports.getStatusCode = getStatusCode;
 function getStatusCode(errorCode) {
     let statusCode;
     if (/HPE_INVALID/.test(errorCode)) {
@@ -21,4 +21,3 @@ function getStatusCode(errorCode) {
     }
     return statusCode;
 }
-exports.getStatusCode = getStatusCode;

package/dist/types.d.ts

@@ -2,16 +2,12 @@
  * Based on definition by DefinitelyTyped:
  * https://github.com/DefinitelyTyped/DefinitelyTyped/blob/6f529c6c67a447190f86bfbf894d1061e41e07b7/types/http-proxy-middleware/index.d.ts
  */
-/// <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 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>;
+    (req: TReq, res: TRes, next?: TNext): Promise<void>;
     upgrade: (req: http.IncomingMessage, socket: net.Socket, head: Buffer) => void;
 }
 export type Filter<TReq = http.IncomingMessage> = string | string[] | ((pathname: string, req: TReq) => boolean);

package/dist/utils/function.js

@@ -1,8 +1,7 @@
 "use strict";
 /* eslint-disable @typescript-eslint/ban-types */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFunctionName = void 0;
+exports.getFunctionName = getFunctionName;
 function getFunctionName(fn) {
     return fn.name || '[anonymous Function]';
 }
-exports.getFunctionName = getFunctionName;

package/dist/utils/logger-plugin.d.ts

@@ -0,0 +1,7 @@
+import type { Agent } from 'node:http';
+export type Sockets = Pick<Agent, 'sockets'>;
+/**
+ * Get port from target
+ * Using proxyRes.req.agent.sockets to determine the target port
+ */
+export declare function getPort(sockets?: Sockets): string | undefined;

package/dist/utils/logger-plugin.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPort = getPort;
+/**
+ * Get port from target
+ * Using proxyRes.req.agent.sockets to determine the target port
+ */
+function getPort(sockets) {
+    return Object.keys(sockets || {})?.[0]?.split(':')[1];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-proxy-middleware",
-  "version": "3.0.0",
+  "version": "3.0.1-beta.1",
   "description": "The one-liner node.js proxy middleware for connect, express, next.js and more",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,6 +9,7 @@
   ],
   "scripts": {
     "clean": "rm -rf dist coverage tsconfig.tsbuildinfo .eslintcache",
+    "install:all": "yarn && (cd examples && yarn)",
     "lint": "yarn prettier && yarn eslint",
     "lint:fix": "yarn prettier:fix && yarn eslint:fix",
     "eslint": "eslint '{src,test}/**/*.ts' --cache",
@@ -22,9 +23,12 @@
     "prepack": "yarn clean && yarn test && yarn build",
     "spellcheck": "npx --yes cspell --show-context --show-suggestions '**/*.*'"
   },
+  "publishConfig": {
+    "provenance": true
+  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/chimurai/http-proxy-middleware.git"
+    "url": "git+https://github.com/chimurai/http-proxy-middleware.git"
   },
   "keywords": [
     "reverse",
@@ -51,21 +55,19 @@
   },
   "homepage": "https://github.com/chimurai/http-proxy-middleware#readme",
   "devDependencies": {
-    "@commitlint/cli": "17.7.1",
-    "@commitlint/config-conventional": "17.7.0",
+    "@commitlint/cli": "19.3.0",
+    "@commitlint/config-conventional": "19.2.2",
     "@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/micromatch": "4.0.9",
+    "@types/node": "20.14.10",
+    "@types/supertest": "6.0.2",
     "@types/ws": "8.5.10",
-    "@typescript-eslint/eslint-plugin": "7.4.0",
-    "@typescript-eslint/parser": "7.4.0",
+    "@typescript-eslint/eslint-plugin": "7.16.0",
+    "@typescript-eslint/parser": "7.16.0",
     "body-parser": "1.20.2",
-    "browser-sync": "3.0.2",
-    "connect": "3.7.0",
     "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-prettier": "5.1.3",
@@ -73,22 +75,22 @@
     "get-port": "5.1.1",
     "husky": "9.0.11",
     "jest": "29.7.0",
-    "lint-staged": "15.2.2",
-    "mockttp": "3.10.1",
+    "lint-staged": "15.2.7",
+    "mockttp": "3.14.0",
     "open": "8.4.2",
-    "prettier": "3.2.5",
-    "supertest": "6.3.4",
-    "ts-jest": "29.1.2",
-    "typescript": "5.4.3",
-    "ws": "8.16.0"
+    "prettier": "3.3.2",
+    "supertest": "7.0.0",
+    "ts-jest": "29.2.2",
+    "typescript": "5.5.3",
+    "ws": "8.18.0"
   },
   "dependencies": {
-    "@types/http-proxy": "^1.17.10",
-    "debug": "^4.3.4",
+    "@types/http-proxy": "^1.17.14",
+    "debug": "^4.3.5",
     "http-proxy": "^1.18.1",
-    "is-glob": "^4.0.1",
+    "is-glob": "^4.0.3",
     "is-plain-obj": "^3.0.0",
-    "micromatch": "^4.0.5"
+    "micromatch": "^4.0.7"
   },
   "engines": {
     "node": "^14.15.0 || ^16.10.0 || >=18.0.0"