Merge branch 'v2'

Author: harmony7

CHANGELOG.md

@@ -6,6 +6,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [unreleased]
+- Major update improving simplicity
+- Simplified build, now exported as ESM modules only.
+- Separated out Node.js support into its own export, `"@fanoutio/serve-grip/node"`.
+  - This exports a version of `ServeGrip` that works with Node.js's `IncomingMessage` objects.
+  - Added conditional export "node" that makes this available on the main `@fanoutio/serve-grip`
+    export as well when the condition `"node"` is present when resolving imports.
+- Removed `IGripApiRequest` and `IGripApiResponse` interfaces.
+  - Subclasses of `ServeGripBase` are now to work directly with the TRequest and TResponse objects.
 
 ## [1.3.1] - 2023-09-14
 - Bump dependency versions

README.md

@@ -18,6 +18,14 @@ This library also supports legacy services hosted by [Fanout](https://fanout.io/
 
 Authors: Katsuyuki Omuro <[email protected]>, Konstantin Bokarius <[email protected]>
 
+## New for v2
+
+### Breaking changes
+
+- Simplified build, now exported as ESM modules only. If you require CommonJS support or
+  a browser build, use v1.
+- A number of classes and interfaces have been removed for simplification.
+
 ### Introduction
 
 [GRIP](https://pushpin.org/docs/protocols/grip/) is a protocol that enables a web service to
@@ -30,7 +38,7 @@ Next.js. It:
 * provides your route handler with tools to handle such requests, such as:
   * access to information about whether the current request is proxied or is signed
   * methods you can call to issue any instructions to the GRIP proxy
-* provides access to the the publisher object, enabling your application to publish messages through
+* provides access to the `Publisher` object, enabling your application to publish messages through
   the GRIP publisher.
 
 Additionally, `serve-grip` also handles
@@ -152,10 +160,18 @@ middleware in a shared location and reference it from your API routes.
 
 ### Configuration
 
-`@fanoutio/serve-grip` exports a constructor function, `ServeGrip`.  This constructor takes a
+`@fanoutio/serve-grip/node` exports a constructor function, `ServeGrip`.  This constructor takes a
 configuration object that can be used to configure the instance, such as the GRIP proxies to use
 for publishing or whether incoming requests should require a GRIP proxy.
 
+> [!IMPORTANT]  
+> `ServeGrip` is a subclass of `ServeGripBase` that works with `IncomingRequest` and `ServerResponse`
+> classes provided by Node.js. `ServeGrip` is also available on the main `@fanoutio/serve-grip` export
+> when the condition `"node"` is present when resolving imports (the default in Node.js applications).
+> 
+> This design allows non-Node.js platforms (such as [Expressly](https://expressly.edgecompute.app)) to
+> extend `ServeGripBase` without holding a dependency on types provided by Node.js.
+
 The following is an example of configuration against Pushpin running on localhost:
 ```javascript
 import { ServeGrip } from '@fanoutio/serve-grip';
@@ -316,3 +332,9 @@ If you have used `express-grip` in the past, you will notice that this library n
 requires the use of pre-route and post-route middlewares.  Consequently, you do not need to
 call `next()` for route handlers that complete their work.  In fact, you should follow the
 standard practice of calling `res.end()` at the end of each of your route handlers.
+
+## License
+
+(C) 2015, 2020 Fanout, Inc.  
+(C) 2024 Fastly, Inc.
+Licensed under the MIT License, see file LICENSE.md for details.

examples/express-http/server.js

@@ -3,7 +3,7 @@ const { ServeGrip } = require( '@fanoutio/serve-grip' );
 
 const PORT = 3000;
 const CHANNEL_NAME = 'test';
-const PUSHPIN_URL = "http://localhost:5561/";
+const PUSHPIN_URL = 'http://localhost:5561/';
 
 const app = express();
 

examples/express-ws/server.js

@@ -4,7 +4,7 @@ const { WebSocketMessageFormat } = require( '@fanoutio/grip' );
 
 const PORT = 3000;
 const CHANNEL_NAME = 'test';
-const PUSHPIN_URL = "http://localhost:5561/";
+const PUSHPIN_URL = 'http://localhost:5561/';
 
 const app = express();
 

examples/koa-http/server.js

@@ -5,7 +5,7 @@ const { ServeGrip } = require( '@fanoutio/serve-grip' );
 
 const PORT = 3000;
 const CHANNEL_NAME = 'test';
-const PUSHPIN_URL = "http://localhost:5561/";
+const PUSHPIN_URL = 'http://localhost:5561/';
 
 const app = new Koa();
 
@@ -33,7 +33,7 @@ router.get('/api/stream', ctx => {
     } else {
 
         ctx.set('Content-Type', 'text/plain');
-        ctx.body = "[not proxied]\n";
+        ctx.body = '[not proxied]\n';
 
     }
 

examples/koa-ws/server.js

@@ -6,7 +6,7 @@ const { WebSocketMessageFormat } = require( '@fanoutio/grip' );
 
 const PORT = 3000;
 const CHANNEL_NAME = 'test';
-const PUSHPIN_URL = "http://localhost:5561/";
+const PUSHPIN_URL = 'http://localhost:5561/';
 
 const app = new Koa();
 

examples/next-http/lib/grip.js

@@ -1,7 +1,7 @@
-import { ServeGrip } from "@fanoutio/serve-grip";
+import { ServeGrip } from '@fanoutio/serve-grip';
 
 export const CHANNEL_NAME = 'test';
-const PUSHPIN_URL = "http://localhost:5561/";
+const PUSHPIN_URL = 'http://localhost:5561/';
 
 export const serveGrip = new ServeGrip({
     grip: {

examples/next-http/pages/api/publish.js

@@ -1,4 +1,4 @@
-import { CHANNEL_NAME, serveGrip } from "../../lib/grip";
+import { CHANNEL_NAME, serveGrip } from '../../lib/grip';
 
 export default async (req, res) => {
 

examples/next-http/pages/api/stream.js

@@ -1,4 +1,4 @@
-import { CHANNEL_NAME, serveGrip } from "../../lib/grip";
+import { CHANNEL_NAME, serveGrip } from '../../lib/grip';
 
 export default async (req, res) => {
 

examples/next-ws/lib/grip.js

@@ -1,7 +1,7 @@
-import { ServeGrip } from "@fanoutio/serve-grip";
+import { ServeGrip } from '@fanoutio/serve-grip';
 
 export const CHANNEL_NAME = 'test';
-const PUSHPIN_URL = "http://localhost:5561/";
+const PUSHPIN_URL = 'http://localhost:5561/';
 
 export const serveGrip = new ServeGrip({
     grip: {