Merge pull request #114 from MatthewWid/feat/public-adapters

Add public connection adapters

Author: MatthewWid

CHANGELOG.md

@@ -7,13 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+
+* Added support for passing custom [connection adapters](https://matthewwid.github.io/better-sse/guides/connection-adapters/) to the `Session` constructor that enables compatibility with any protocol, framework or runtime environment.
+
 ### Changed
 
 * Update event ID generation to use `randomUUID` from the [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Crypto/randomUUID) instead of [`node:crypto`](https://nodejs.org/api/crypto.html).
+* Update Node HTTP/1 and HTTP/2 Compatibility adapters to [disable Nagle's algorithm](https://nodejs.org/docs/latest/api/net.html#socketsetnodelaynodelay) on the underlying socket to reduce latency.
 
 ### Fixed
 
 * Fixed [a warning](https://nodejs.org/api/events.html#emittersetmaxlistenersn) being printed by the Node internals when adding more than ten listeners to events emitted by sessions and channels.
+* Fixed a crash that occurred when the request had no `Host` header when using the [Node HTTP/1](https://nodejs.org/api/http.html) or [Node HTTP/2 Compatibility](https://nodejs.org/api/http2.html#compatibility-api) API.
 
 ## 0.15.1 - 2025-05-26
 

docs/astro.config.ts

@@ -21,6 +21,7 @@ export default defineConfig({
 						"guides/getting-started",
 						"guides/channels",
 						"guides/batching",
+						"guides/connection-adapters",
 					],
 				},
 				{

docs/src/components/built-in-connection-options.mdx

@@ -0,0 +1,9 @@
+import StatusCodeDescription from './status-code-description.mdx'
+import HeadersDescription from './headers-description.mdx'
+
+`options` is a `BuiltInConnectionOptions` object with the following properties:
+
+|Property|Type|Default|Description|
+|-|-|-|-|
+|`statusCode`|`number`|`200`|<StatusCodeDescription />|
+|`headers`|`object`|`{}`|<HeadersDescription />|

docs/src/components/headers-description.mdx

@@ -0,0 +1 @@
+Additional headers to be sent along with the response.

docs/src/components/status-code-description.mdx

@@ -0,0 +1 @@
+Status code to be sent to the client.<br /><br />Event stream requests can be redirected using HTTP 301 and 307 status codes. Make sure to set `Location` header when using these status codes (301/307) using the `headers` property.<br /><br />A client can be asked to stop reconnecting by send a 204 status code.