chore(package.json): esm only [BREAKING CHANGE] (#1181)

Author: chimurai

CHANGELOG.md

@@ -5,8 +5,10 @@
 - fix(types): fix Logger type
 - fix(error-response-plugin): sanitize input
 - feat: drop node v14/v16/v18 [BREAKING CHANGE]
-- refactor(#1136): replace http-proxy w/ httpxy [BREAKING CHANGE]
+- refactor(#1136): replace http-proxy w/ httpxy
 - chore: remove legacyCreateProxyMiddleware() [BREAKING CHANGE]
+- ci: migrate from jest to vitest
+- chore(package.json): esm only [BREAKING CHANGE]
 
 ## [v3.0.5](https://github.com/chimurai/http-proxy-middleware/releases/tag/v3.0.5)
 

README.md

@@ -28,7 +28,7 @@ Proxy `/api` requests to `http://www.example.org`
 
 ```typescript
 // typescript
-import * as express from 'express';
+import express from 'express';
 import type { NextFunction, Request, Response } from 'express';
 import { createProxyMiddleware } from 'http-proxy-middleware';
 import type { Filter, Options, RequestHandler } from 'http-proxy-middleware';
@@ -93,7 +93,7 @@ npm install --save-dev http-proxy-middleware
 Create and configure a proxy middleware with: `createProxyMiddleware(config)`.
 
 ```javascript
-const { createProxyMiddleware } = require('http-proxy-middleware');
+import { createProxyMiddleware } from 'http-proxy-middleware';
 
 const apiProxy = createProxyMiddleware({
   target: 'http://www.example.org',
@@ -114,13 +114,13 @@ An example with `express` server.
 
 ```javascript
 // include dependencies
-const express = require('express');
-const { createProxyMiddleware } = require('http-proxy-middleware');
+import express from 'express';
+import { createProxyMiddleware } from 'http-proxy-middleware';
 
 const app = express();
 
 // create the proxy
-/** @type {import('http-proxy-middleware/dist/types').RequestHandler<express.Request, express.Response>} */
+/** @type {import('http-proxy-middleware').RequestHandler<import('express').Request, import('express').Response>} */
 const exampleProxy = createProxyMiddleware({
   target: 'http://www.example.org/api', // target host with the same base path
   changeOrigin: true, // needed for virtual hosted sites
@@ -281,13 +281,15 @@ NOTE: register your own error handlers to prevent server from crashing.
 
 ```js
 // eject default plugins and manually add them back
-
-const {
-  debugProxyErrorsPlugin, // subscribe to proxy errors to prevent server from crashing
-  loggerPlugin, // log proxy events to a logger (ie. console)
-  errorResponsePlugin, // return 5xx response on proxy error
+import {
+  debugProxyErrorsPlugin,
+  // log proxy events to a logger (ie. console)
+  errorResponsePlugin,
+  // subscribe to proxy errors to prevent server from crashing
+  loggerPlugin,
+  // return 5xx response on proxy error
   proxyEventsPlugin, // implements the "on:" option
-} = require('http-proxy-middleware');
+} from 'http-proxy-middleware';
 
 createProxyMiddleware({
   target: `http://example.org`,
@@ -497,7 +499,7 @@ Currently the only pre-provided request interceptor is `fixRequestBody`, which i
 Example:
 
 ```javascript
-const { createProxyMiddleware, fixRequestBody } = require('http-proxy-middleware');
+import { createProxyMiddleware, fixRequestBody } from 'http-proxy-middleware';
 
 const proxy = createProxyMiddleware({
   /**
@@ -522,7 +524,7 @@ NOTE: `responseInterceptor` disables streaming of target's response.
 Example:
 
 ```javascript
-const { createProxyMiddleware, responseInterceptor } = require('http-proxy-middleware');
+import { createProxyMiddleware, responseInterceptor } from 'http-proxy-middleware';
 
 const proxy = createProxyMiddleware({
   /**

examples/browser-sync/index.js

@@ -1,8 +1,11 @@
 /**
  * Module dependencies.
  */
-const browserSync = require('browser-sync').create();
-const { createProxyMiddleware } = require('../../dist'); // require('http-proxy-middleware');
+import browserSync from 'browser-sync';
+
+import { createProxyMiddleware } from '../../dist/index.js';
+
+const app = browserSync.create();
 
 /**
  * Configure proxy middleware
@@ -17,7 +20,7 @@ const jsonPlaceholderProxy = createProxyMiddleware({
 /**
  * Add the proxy to browser-sync
  */
-browserSync.init({
+app.init({
   server: {
     baseDir: './',
     port: 3000,
@@ -29,5 +32,5 @@ browserSync.init({
 console.log('[DEMO] Server: listening on port 3000');
 console.log('[DEMO] Opening: http://localhost:3000/users');
 
-process.on('SIGINT', () => browserSync.exit());
-process.on('SIGTERM', () => browserSync.exit());
+process.on('SIGINT', () => app.exit());
+process.on('SIGTERM', () => app.exit());

examples/connect/index.js

@@ -1,9 +1,12 @@
 /**
  * Module dependencies.
  */
-const http = require('http');
-const connect = require('connect');
-const { createProxyMiddleware } = require('../../dist'); // require('http-proxy-middleware');
+import * as http from 'node:http';
+
+import connect from 'connect';
+import open from 'open';
+
+import { createProxyMiddleware } from '../../dist/index.js';
 
 /**
  * Configure proxy middleware
@@ -25,7 +28,7 @@ const server = http.createServer(app).listen(3000);
 console.log('[DEMO] Server: listening on port 3000');
 console.log('[DEMO] Opening: http://localhost:3000/users');
 
-require('open')('http://localhost:3000/users');
+open('http://localhost:3000/users');
 
 process.on('SIGINT', () => server.close());
 process.on('SIGTERM', () => server.close());

examples/express/index.js

@@ -1,8 +1,10 @@
 /**
  * Module dependencies.
  */
-const express = require('express');
-const { createProxyMiddleware } = require('../../dist'); // require('http-proxy-middleware');
+import express from 'express';
+import open from 'open';
+
+import { createProxyMiddleware } from '../../dist/index.js';
 
 /**
  * Configure proxy middleware
@@ -25,7 +27,7 @@ const server = app.listen(3000);
 console.log('[DEMO] Server: listening on port 3000');
 console.log('[DEMO] Opening: http://localhost:3000/users');
 
-require('open')('http://localhost:3000/users');
+open('http://localhost:3000/users');
 
 process.on('SIGINT', () => server.close());
 process.on('SIGTERM', () => server.close());

examples/fastify/index.js

@@ -1,8 +1,13 @@
-const fastify = require('fastify')({ logger: true });
-const { createProxyMiddleware } = require('../../dist'); // require('http-proxy-middleware');
+import fastifyExpress from '@fastify/express';
+import fastifyFactory from 'fastify';
+import open from 'open';
+
+import { createProxyMiddleware } from '../../dist/index.js';
+
+const fastify = fastifyFactory({ logger: true });
 
 (async () => {
-  await fastify.register(require('@fastify/express'));
+  await fastify.register(fastifyExpress);
 
   const proxy = createProxyMiddleware({
     target: 'http://jsonplaceholder.typicode.com',
@@ -15,6 +20,6 @@ const { createProxyMiddleware } = require('../../dist'); // require('http-proxy-
     if (err) throw err;
     fastify.log.info(`server listening on ${address}`);
 
-    require('open')(`${address}/users`);
+    open(`${address}/users`);
   });
 })();

examples/http-server/index.js

@@ -1,8 +1,11 @@
 /**
  * Module dependencies.
  */
-const http = require('node:http');
-const { createProxyMiddleware } = require('../../dist'); // require('http-proxy-middleware');
+import * as http from 'node:http';
+
+import open from 'open';
+
+import { createProxyMiddleware } from '../../dist/index.js';
 
 /**
  * Configure proxy middleware
@@ -23,7 +26,7 @@ server.listen(3000);
 console.log('[DEMO] Server: listening on port 3000');
 console.log('[DEMO] Opening: http://localhost:3000/users');
 
-require('open')('http://localhost:3000/users');
+open('http://localhost:3000/users');
 
 process.on('SIGINT', () => server.close());
 process.on('SIGTERM', () => server.close());

examples/package.json

@@ -1,6 +1,7 @@
 {
   "name": "examples",
   "version": "1.0.0",
+  "type": "module",
   "private": "true",
   "description": "View working examples of `http-proxy-middleware` implemented in popular servers.",
   "scripts": {

examples/response-interceptor/index.js

@@ -1,11 +1,12 @@
 // file deepcode ignore DisablePoweredBy: example code
 // file deepcode ignore UseCsurfForExpress: example code
-
 /**
  * Module dependencies.
  */
-const express = require('express');
-const { createProxyMiddleware, responseInterceptor } = require('../../dist'); // require('http-proxy-middleware');
+import express from 'express';
+import open from 'open';
+
+import { createProxyMiddleware, responseInterceptor } from '../../dist/index.js';
 
 // test with double-byte characters
 // cSpell:ignore Kroket, ส้มตำไทย, चिकन
@@ -78,7 +79,7 @@ console.log('[DEMO] Open: http://localhost:3000/brotli');
 console.log('[DEMO] Open: http://localhost:3000/gzip');
 console.log('[DEMO] Open: http://localhost:3000/deflate');
 
-require('open')('http://localhost:3000/users');
+open('http://localhost:3000/users');
 
 process.on('SIGINT', () => server.close());
 process.on('SIGTERM', () => server.close());

examples/websocket/index.js

@@ -1,8 +1,14 @@
 /**
  * Module dependencies.
  */
-const express = require('express');
-const { createProxyMiddleware } = require('../../dist'); // require('http-proxy-middleware');
+import { fileURLToPath } from 'node:url';
+
+import express from 'express';
+import open from 'open';
+
+import { createProxyMiddleware } from '../../dist/index.js';
+
+const currentDir = fileURLToPath(new URL('.', import.meta.url));
 
 /**
  * Configure proxy middleware
@@ -19,7 +25,7 @@ const wsProxy = createProxyMiddleware({
 });
 
 const app = express();
-app.use('/', express.static(__dirname)); // demo page
+app.use('/', express.static(currentDir)); // demo page
 app.use(wsProxy); // add the proxy to express
 
 const server = app.listen(3000);
@@ -28,7 +34,7 @@ server.on('upgrade', wsProxy.upgrade); // optional: upgrade externally
 console.log('[DEMO] Server: listening on port 3000');
 console.log('[DEMO] Opening: http://localhost:3000');
 
-require('open')('http://localhost:3000');
+open('http://localhost:3000');
 
 /**
  * Example: