http-proxy-middleware 2.0.1 → 2.0.4

package/README.md

@@ -2,7 +2,6 @@
 
 [![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/chimurai/http-proxy-middleware/CI/master?style=flat-square)](https://github.com/chimurai/http-proxy-middleware/actions?query=branch%3Amaster)
 [![Coveralls](https://img.shields.io/coveralls/chimurai/http-proxy-middleware.svg?style=flat-square)](https://coveralls.io/r/chimurai/http-proxy-middleware)
-[![dependency Status](https://img.shields.io/david/chimurai/http-proxy-middleware.svg?style=flat-square)](https://david-dm.org/chimurai/http-proxy-middleware#info=dependencies)
 [![dependency Status](https://snyk.io/test/npm/http-proxy-middleware/badge.svg?style=flat-square)](https://snyk.io/test/npm/http-proxy-middleware)
 [![npm](https://img.shields.io/npm/v/http-proxy-middleware?color=%23CC3534&style=flat-square)](https://www.npmjs.com/package/http-proxy-middleware)
 
@@ -10,14 +9,14 @@ Node.js proxying made simple. Configure proxy middleware with ease for [connect]
 
 Powered by the popular Nodejitsu [`http-proxy`](https://github.com/nodejitsu/node-http-proxy). [![GitHub stars](https://img.shields.io/github/stars/nodejitsu/node-http-proxy.svg?style=social&label=Star)](https://github.com/nodejitsu/node-http-proxy)
 
-## ⚠️ Note
+## ⚠️ Note <!-- omit in toc -->
 
-This page is showing documentation for version v1.x.x ([release notes](https://github.com/chimurai/http-proxy-middleware/releases))
+This page is showing documentation for version v2.x.x ([release notes](https://github.com/chimurai/http-proxy-middleware/releases))
 
 If you're looking for v0.x documentation. Go to:
 https://github.com/chimurai/http-proxy-middleware/tree/v0.21.0#readme
 
-## TL;DR
+## TL;DR <!-- omit in toc -->
 
 Proxy `/api` requests to `http://www.example.org`
 
@@ -53,9 +52,7 @@ _All_ `http-proxy` [options](https://github.com/nodejitsu/node-http-proxy#option
 
 :bulb: **Tip:** Set the option `changeOrigin` to `true` for [name-based virtual hosted sites](http://en.wikipedia.org/wiki/Virtual_hosting#Name-based).
 
-## Table of Contents
-
-<!-- MarkdownTOC autolink=true bracket=round depth=2 -->
+## Table of Contents <!-- omit in toc -->
 
 - [Install](#install)
 - [Core concept](#core-concept)
@@ -66,7 +63,7 @@ _All_ `http-proxy` [options](https://github.com/nodejitsu/node-http-proxy#option
   - [http-proxy events](#http-proxy-events)
   - [http-proxy options](#http-proxy-options)
 - [Shorthand](#shorthand)
-  - [app.use\(path, proxy\)](#appusepath-proxy)
+  - [app.use(path, proxy)](#appusepath-proxy)
 - [WebSocket](#websocket)
   - [External WebSocket upgrade](#external-websocket-upgrade)
 - [Intercept and manipulate requests](#intercept-and-manipulate-requests)
@@ -78,8 +75,6 @@ _All_ `http-proxy` [options](https://github.com/nodejitsu/node-http-proxy#option
 - [Changelog](#changelog)
 - [License](#license)
 
-<!-- /MarkdownTOC -->
-
 ## Install
 
 ```bash
@@ -128,6 +123,7 @@ const express = require('express');
 const { createProxyMiddleware } = require('http-proxy-middleware');
 
 // proxy middleware options
+/** @type {import('http-proxy-middleware/dist/types').Options} */
 const options = {
   target: 'http://www.example.org', // target host
   changeOrigin: true, // needed for virtual hosted sites
@@ -341,7 +337,7 @@ Subscribe to [http-proxy events](https://github.com/nodejitsu/node-http-proxy#li
   ```javascript
   function onOpen(proxySocket) {
     // listen for messages coming FROM the target here
-    proxySocket.on('data', hybiParseAndLogMessage);
+    proxySocket.on('data', hybridParseAndLogMessage);
   }
   ```
 
@@ -586,6 +582,9 @@ $ yarn test
 
 # code coverage
 $ yarn cover
+
+# check spelling mistakes
+$ yarn spellcheck
 ```
 
 ## Changelog
@@ -596,4 +595,4 @@ $ yarn cover
 
 The MIT License (MIT)
 
-Copyright (c) 2015-2021 Steven Chim
+Copyright (c) 2015-2022 Steven Chim

package/dist/_handlers.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getHandlers = exports.init = void 0;
 const logger_1 = require("./logger");
-const logger = logger_1.getInstance();
+const logger = (0, logger_1.getInstance)();
 function init(proxy, option) {
     const handlers = getHandlers(option);
     for (const eventName of Object.keys(handlers)) {
@@ -66,7 +66,7 @@ function defaultErrorHandler(err, req, res) {
             }
         }
     }
-    res.end(`Error occured while trying to proxy: ${host}${req.url}`);
+    res.end(`Error occurred while trying to proxy: ${host}${req.url}`);
 }
 function logClose(req, socket, head) {
     // view disconnected websocket connections

package/dist/config-factory.js

@@ -5,7 +5,7 @@ const isPlainObj = require("is-plain-obj");
 const url = require("url");
 const errors_1 = require("./errors");
 const logger_1 = require("./logger");
-const logger = logger_1.getInstance();
+const logger = (0, logger_1.getInstance)();
 function createConfig(context, opts) {
     // structure of config object to be returned
     const config = {

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

@@ -7,7 +7,7 @@ const querystring = require("querystring");
  */
 function fixRequestBody(proxyReq, req) {
     const requestBody = req.body;
-    if (!requestBody || !Object.keys(requestBody).length) {
+    if (!requestBody) {
         return;
     }
     const contentType = proxyReq.getHeader('Content-Type');
@@ -19,7 +19,7 @@ function fixRequestBody(proxyReq, req) {
     if (contentType && contentType.includes('application/json')) {
         writeBody(JSON.stringify(requestBody));
     }
-    if (contentType === 'application/x-www-form-urlencoded') {
+    if (contentType && contentType.includes('application/x-www-form-urlencoded')) {
         writeBody(querystring.stringify(requestBody));
     }
 }

package/dist/http-proxy-middleware.js

@@ -10,7 +10,7 @@ const PathRewriter = require("./path-rewriter");
 const Router = require("./router");
 class HttpProxyMiddleware {
     constructor(context, opts) {
-        this.logger = logger_1.getInstance();
+        this.logger = (0, logger_1.getInstance)();
         this.wsInternalSubscribed = false;
         this.serverOnCloseSubscribed = false;
         // https://github.com/Microsoft/TypeScript/wiki/'this'-in-TypeScript#red-flags-for-this
@@ -98,7 +98,7 @@ class HttpProxyMiddleware {
             await this.applyPathRewrite(req, this.pathRewriter);
             // debug logging for both http(s) and websockets
             if (this.proxyOptions.logLevel === 'debug') {
-                const arrow = logger_1.getArrow(originalPath, req.url, this.proxyOptions.target, newProxyOptions.target);
+                const arrow = (0, logger_1.getArrow)(originalPath, req.url, this.proxyOptions.target, newProxyOptions.target);
                 this.logger.debug('[HPM] %s %s %s %s', req.method, originalPath, arrow, newProxyOptions.target);
             }
             return newProxyOptions;
@@ -135,7 +135,7 @@ class HttpProxyMiddleware {
             const errReference = 'https://nodejs.org/api/errors.html#errors_common_system_errors'; // link to Node Common Systems Errors page
             this.logger.error(errorMessage, requestHref, targetHref, err.code || err, errReference);
         };
-        this.config = config_factory_1.createConfig(context, opts);
+        this.config = (0, config_factory_1.createConfig)(context, opts);
         this.proxyOptions = this.config.options;
         // create proxy
         this.proxy = httpProxy.createProxyServer({});

package/dist/path-rewriter.js

@@ -4,7 +4,7 @@ exports.createPathRewriter = void 0;
 const isPlainObj = require("is-plain-obj");
 const errors_1 = require("./errors");
 const logger_1 = require("./logger");
-const logger = logger_1.getInstance();
+const logger = (0, logger_1.getInstance)();
 /**
  * Create rewrite function, to cache parsed rewrite rules.
  *

package/dist/router.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTarget = void 0;
 const isPlainObj = require("is-plain-obj");
 const logger_1 = require("./logger");
-const logger = logger_1.getInstance();
+const logger = (0, logger_1.getInstance)();
 async function getTarget(req, config) {
     let newTarget;
     const router = config.router;

package/dist/types.d.ts

@@ -45,10 +45,10 @@ export declare type LogProviderCallback = (provider: LogProvider) => LogProvider
  * Use types based on the events listeners from http-proxy
  * https://github.com/DefinitelyTyped/DefinitelyTyped/blob/51504fd999031b7f025220fab279f1b2155cbaff/types/http-proxy/index.d.ts
  */
-export declare type OnErrorCallback = (err: Error, req: http.IncomingMessage, res: http.ServerResponse, target?: string | Partial<url.Url>) => void;
-export declare type OnProxyResCallback = (proxyRes: http.IncomingMessage, req: http.IncomingMessage, res: http.ServerResponse) => void;
-export declare type OnProxyReqCallback = (proxyReq: http.ClientRequest, req: http.IncomingMessage, res: http.ServerResponse, options: httpProxy.ServerOptions) => void;
-export declare type OnProxyReqWsCallback = (proxyReq: http.ClientRequest, req: http.IncomingMessage, socket: net.Socket, options: httpProxy.ServerOptions, head: any) => void;
-export declare type OnCloseCallback = (proxyRes: http.IncomingMessage, proxySocket: net.Socket, proxyHead: any) => void;
+export declare type OnErrorCallback = (err: Error, req: Request, res: Response, target?: string | Partial<url.Url>) => void;
+export declare type OnProxyResCallback = (proxyRes: http.IncomingMessage, req: Request, res: Response) => void;
+export declare type OnProxyReqCallback = (proxyReq: http.ClientRequest, req: Request, res: Response, options: httpProxy.ServerOptions) => void;
+export declare type OnProxyReqWsCallback = (proxyReq: http.ClientRequest, req: Request, socket: net.Socket, options: httpProxy.ServerOptions, head: any) => void;
+export declare type OnCloseCallback = (proxyRes: Response, proxySocket: net.Socket, proxyHead: any) => void;
 export declare type OnOpenCallback = (proxySocket: net.Socket) => void;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-proxy-middleware",
-  "version": "2.0.1",
+  "version": "2.0.4",
   "description": "The one-liner node.js proxy middleware for connect, express and browser-sync",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,7 +21,9 @@
     "test": "jest",
     "precoverage": "yarn build",
     "coverage": "jest --coverage --coverageReporters=lcov",
-    "prepare": "husky install && yarn build && rm dist/tsconfig.tsbuildinfo"
+    "prepare": "husky install",
+    "prepack": "yarn build && rm dist/tsconfig.tsbuildinfo",
+    "spellcheck": "npx --yes cspell --show-context --show-suggestions '**/*.*'"
   },
   "repository": {
     "type": "git",
@@ -51,43 +53,51 @@
   },
   "homepage": "https://github.com/chimurai/http-proxy-middleware#readme",
   "devDependencies": {
-    "@commitlint/cli": "^12.1.4",
-    "@commitlint/config-conventional": "^12.1.4",
-    "@types/express": "4.17.7",
-    "@types/is-glob": "^4.0.1",
-    "@types/jest": "^26.0.23",
-    "@types/micromatch": "^4.0.1",
-    "@types/node": "^15.6.2",
-    "@types/supertest": "^2.0.11",
-    "@types/ws": "^7.4.4",
-    "@typescript-eslint/eslint-plugin": "^4.26.0",
-    "@typescript-eslint/parser": "^4.26.0",
-    "body-parser": "^1.19.0",
-    "browser-sync": "^2.26.14",
-    "connect": "^3.7.0",
-    "eslint": "^7.27.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "express": "^4.17.1",
-    "get-port": "^5.1.1",
-    "husky": "^6.0.0",
-    "jest": "^27.0.3",
-    "lint-staged": "^11.0.0",
-    "mockttp": "^1.2.2",
-    "open": "^8.2.0",
-    "prettier": "^2.3.0",
-    "supertest": "^6.1.3",
-    "ts-jest": "^27.0.2",
-    "typescript": "^4.3.2",
-    "ws": "^7.4.6"
+    "@commitlint/cli": "16.2.1",
+    "@commitlint/config-conventional": "16.2.1",
+    "@types/express": "4.17.13",
+    "@types/is-glob": "4.0.2",
+    "@types/jest": "27.4.0",
+    "@types/micromatch": "4.0.2",
+    "@types/node": "17.0.18",
+    "@types/supertest": "2.0.11",
+    "@types/ws": "8.2.2",
+    "@typescript-eslint/eslint-plugin": "5.12.0",
+    "@typescript-eslint/parser": "5.12.0",
+    "body-parser": "1.19.2",
+    "browser-sync": "2.27.7",
+    "connect": "3.7.0",
+    "eslint": "8.9.0",
+    "eslint-config-prettier": "8.3.0",
+    "eslint-plugin-prettier": "4.0.0",
+    "express": "4.17.3",
+    "get-port": "5.1.1",
+    "husky": "7.0.4",
+    "jest": "27.5.1",
+    "lint-staged": "12.3.4",
+    "mockttp": "2.6.0",
+    "open": "8.4.0",
+    "prettier": "2.5.1",
+    "supertest": "6.2.2",
+    "ts-jest": "27.1.3",
+    "typescript": "4.5.5",
+    "ws": "8.5.0"
   },
   "dependencies": {
-    "@types/http-proxy": "^1.17.5",
+    "@types/http-proxy": "^1.17.8",
     "http-proxy": "^1.18.1",
     "is-glob": "^4.0.1",
     "is-plain-obj": "^3.0.0",
     "micromatch": "^4.0.2"
   },
+  "peerDependencies": {
+    "@types/express": "^4.17.13"
+  },
+  "peerDependenciesMeta": {
+    "@types/express": {
+      "optional": true
+    }
+  },
   "engines": {
     "node": ">=12.0.0"
   },