@statewalker/webrun-http-streams 0.2.1 → 0.2.2

package/README.md

@@ -3,6 +3,63 @@
 HTTP request / response over a `Duplex` from any `webrun-streams-*` adapter.
 Replaces the retired `webrun-http` + `webrun-http-port` packages.
 
+## Install
+
+```sh
+npm install @statewalker/webrun-http-streams
+```
+
+One runtime dependency, [`@statewalker/webrun-streams`](../webrun-streams); no
+peer dependencies. ESM only (`"type": "module"`). Needs standard `Request`,
+`Response`, `ReadableStream`, `TextEncoder` and `TextDecoder` — present in
+browsers, Node 18+, Deno, Bun and Cloudflare Workers.
+
+Pair it with a transport adapter to get a `Duplex`:
+[`-ws`](../webrun-streams-ws), [`webrun-rpc`](../webrun-rpc),
+[`-webrtc`](../webrun-streams-webrtc), [`-libp2p`](../webrun-streams-libp2p),
+[`-livekit`](../webrun-streams-livekit), [`-peerjs`](../webrun-streams-peerjs).
+
+## Getting started
+
+Pick a transport, then move standard `Request` / `Response` objects across it.
+Here the transport is an in-process `MessageChannel`, so the whole exchange runs
+in one process with no network:
+
+```ts
+import { connect, serve } from "@statewalker/webrun-rpc";
+import { fetchOverDuplex, serveFetchOverDuplex } from "@statewalker/webrun-http-streams";
+
+// --- server side ---
+const channel = new MessageChannel();
+const stop = await serve(
+  { port: channel.port2 },
+  serveFetchOverDuplex(async (request) => {
+    const url = new URL(request.url);
+    return Response.json({ path: url.pathname, method: request.method });
+  }),
+);
+
+// --- client side ---
+const { call, close } = await connect({ port: channel.port1 });
+const response = await fetchOverDuplex(call, new Request("http://local/api/todo/7"));
+
+console.log(response.status);        // 200
+console.log(await response.json());  // { path: "/api/todo/7", method: "GET" }
+
+await close();
+await stop();
+```
+
+Swap `@statewalker/webrun-rpc` for
+[`-ws`](../webrun-streams-ws), [`-webrtc`](../webrun-streams-webrtc),
+[`-libp2p`](../webrun-streams-libp2p), [`-livekit`](../webrun-streams-livekit)
+or [`-peerjs`](../webrun-streams-peerjs) and nothing else changes — that is the
+whole point of the `Duplex` seam.
+
+Streaming bodies work as you would expect: a `Response` whose body is a
+`ReadableStream` streams across the transport chunk by chunk, which is what
+makes server-sent events work over a `MessagePort` or a WebRTC link.
+
 ## Layers
 
 Three of them sit on the `Duplex` seam, plus one older transport-agnostic pair
@@ -73,7 +130,7 @@ signal terminates the call.
 
 ```ts
 import { DuplexSiteBuilder } from "@statewalker/webrun-http-streams";
-import { serve } from "@statewalker/webrun-streams-port";
+import { serve } from "@statewalker/webrun-rpc";
 
 const stop = await new DuplexSiteBuilder()
   .setHandler(siteHandler) // (Request) => Promise<Response>
@@ -88,7 +145,7 @@ own; endpoints, files and auth belong to the `SiteHandler` producer (typically
 `SiteBuilder`).
 
 > Not runnable as written above: it needs a live `MessagePort` and
-> `@statewalker/webrun-streams-port`, which this package does not depend on.
+> `@statewalker/webrun-rpc`, which this package does not depend on.
 > `start` accepts any `Serve<P>`, so an in-process one is enough to exercise
 > it. Calling `start()` before `setHandler()` throws.
 
@@ -314,6 +371,20 @@ exception.
 | `PEER_ERROR_HEADER` | `"x-webrun-error"`. |
 | `MessageCodec`, `ByteSource`, `RequestEnvelope`, `ResponseEnvelope`, `DecodedRequest`, `DecodedResponse`, `ResponseCodecOptions` | The codec seam's types. |
 
+## Dependencies
+
+| Dependency | Kind | Why |
+| --- | --- | --- |
+| [`@statewalker/webrun-streams`](../webrun-streams) | runtime | The `Duplex` seam, chunk collectors and error serialisation. |
+
+No peer dependencies and no runtime dependencies outside the workspace. Relies
+on the platform for `Request`, `Response`, `ReadableStream`, `TextEncoder` and
+`TextDecoder`.
+
+Downstream consumers in this workspace:
+[`webrun-http-browser`](../webrun-http-browser) and
+[`webrun-rpc-http`](../webrun-rpc-http).
+
 ## Scripts
 
 ```sh
@@ -324,4 +395,4 @@ pnpm lint        # biome check src tests
 
 ## License
 
-MIT
+MIT © statewalker — see [LICENSE](../../LICENSE).

package/dist/duplex-site-builder.d.ts

@@ -12,7 +12,7 @@ export type SiteHandler = (request: Request) => Promise<Response>;
  * ```ts
  * import { SiteBuilder } from "@statewalker/webrun-site-builder";
  * import { DuplexSiteBuilder } from "@statewalker/webrun-http-streams";
- * import { serve } from "@statewalker/webrun-streams-port";
+ * import { serve } from "@statewalker/webrun-rpc";
  *
  * const handler = new SiteBuilder()
  *   .setEndpoint("/api/time", () => new Response(new Date().toISOString()))

package/dist/index.js

@@ -1213,7 +1213,7 @@ function abortReason(signal) {
 * ```ts
 * import { SiteBuilder } from "@statewalker/webrun-site-builder";
 * import { DuplexSiteBuilder } from "@statewalker/webrun-http-streams";
-* import { serve } from "@statewalker/webrun-streams-port";
+* import { serve } from "@statewalker/webrun-rpc";
 *
 * const handler = new SiteBuilder()
 *   .setEndpoint("/api/time", () => new Response(new Date().toISOString()))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statewalker/webrun-http-streams",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "private": false,
   "type": "module",
   "description": "HTTP request/response over Duplex — merge of webrun-http + webrun-http-port",
@@ -15,14 +15,17 @@
     "url": "git@github.com:statewalker/webrun-wire.git"
   },
   "exports": {
-    ".": "./src/index.ts"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
   },
   "files": [
     "dist",
     "src"
   ],
   "dependencies": {
-    "@statewalker/webrun-streams": "0.1.1"
+    "@statewalker/webrun-streams": "0.2.0"
   },
   "devDependencies": {
     "@types/node": "^26.2.0",
@@ -35,6 +38,7 @@
   "publishConfig": {
     "access": "public"
   },
+  "types": "./dist/index.d.ts",
   "scripts": {
     "build": "rimraf dist && rolldown -c && tsc --emitDeclarationOnly --declaration",
     "test": "vitest run",

package/src/duplex-site-builder.ts

@@ -15,7 +15,7 @@ export type SiteHandler = (request: Request) => Promise<Response>;
  * ```ts
  * import { SiteBuilder } from "@statewalker/webrun-site-builder";
  * import { DuplexSiteBuilder } from "@statewalker/webrun-http-streams";
- * import { serve } from "@statewalker/webrun-streams-port";
+ * import { serve } from "@statewalker/webrun-rpc";
  *
  * const handler = new SiteBuilder()
  *   .setEndpoint("/api/time", () => new Response(new Date().toISOString()))

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022-2026 statewalker
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.