@statewalker/webrun-http-streams 0.2.1 → 0.2.4

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/http1/encode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"encode.d.ts","sourceRoot":"","sources":["../../src/http1/encode.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAgBnF,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAMF;;;;;;GAMG;AACH,wBAAgB,WAAW,CACzB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,wBAAwB,GAC7B;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CA6BvC;AA0BD,wBAAuB,aAAa,CAClC,GAAG,EAAE,eAAe,EACpB,IAAI,EAAE,UAAU,GAAG,SAAS,EAC5B,IAAI,EAAE,wBAAwB,GAC7B,cAAc,CAAC,UAAU,CAAC,CA+B5B;AAED,wBAAuB,cAAc,CACnC,GAAG,EAAE,gBAAgB,EACrB,IAAI,EAAE,UAAU,GAAG,SAAS,EAK5B,KAAK,EAAE,wBAAwB,EAC/B,aAAa,CAAC,EAAE,MAAM,GACrB,cAAc,CAAC,UAAU,CAAC,CA0C5B"}
+{"version":3,"file":"encode.d.ts","sourceRoot":"","sources":["../../src/http1/encode.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAgBnF,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAMF;;;;;;GAMG;AACH,wBAAgB,WAAW,CACzB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,wBAAwB,GAC7B;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CA+BvC;AA0BD,wBAAuB,aAAa,CAClC,GAAG,EAAE,eAAe,EACpB,IAAI,EAAE,UAAU,GAAG,SAAS,EAC5B,IAAI,EAAE,wBAAwB,GAC7B,cAAc,CAAC,UAAU,CAAC,CA+B5B;AAED,wBAAuB,cAAc,CACnC,GAAG,EAAE,gBAAgB,EACrB,IAAI,EAAE,UAAU,GAAG,SAAS,EAK5B,KAAK,EAAE,wBAAwB,EAC/B,aAAa,CAAC,EAAE,MAAM,GACrB,cAAc,CAAC,UAAU,CAAC,CA0C5B"}

package/dist/http1/headers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"headers.d.ts","sourceRoot":"","sources":["../../src/http1/headers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAG9C,MAAM,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;AAS5C,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEjD;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAM9C;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAItD;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAUrD;AAUD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAIlD;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAOtD;AAwBD,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAExE;AAED,sFAAsF;AACtF,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAEzD;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM,CAQ7D;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,UAAU,EAClB,cAAc,EAAE,MAAM,EACtB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,UAAU,CAAC,CA6BrB;AAED,wBAAgB,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAGlE;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,UAAU,CAG/E;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,CAkBvE;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAExD;AAED,MAAM,MAAM,WAAW,GACnB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAClC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAErB;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,GAAG,WAAW,CA+BhF"}
+{"version":3,"file":"headers.d.ts","sourceRoot":"","sources":["../../src/http1/headers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAG9C,MAAM,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;AAS5C,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEjD;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAM9C;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAItD;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAUrD;AAUD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAIlD;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAOtD;AAwBD,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAExE;AAED,sFAAsF;AACtF,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAEzD;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM,CAQ7D;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,UAAU,EAClB,cAAc,EAAE,MAAM,EACtB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,UAAU,CAAC,CA6BrB;AAED,wBAAgB,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAGlE;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,UAAU,CAG/E;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,CAmBvE;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAExD;AAED,MAAM,MAAM,WAAW,GACnB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAClC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAErB;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,GAAG,WAAW,CA+BhF"}

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.4",
   "private": false,
   "type": "module",
   "description": "HTTP request/response over Duplex — merge of webrun-http + webrun-http-port",
@@ -15,26 +15,32 @@
     "url": "git@github.com:statewalker/webrun-wire.git"
   },
   "exports": {
-    ".": "./src/index.ts"
+    ".": {
+      "source": "./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.1"
   },
   "devDependencies": {
-    "@types/node": "^26.2.0",
+    "@biomejs/biome": "^2.5.15",
+    "@types/node": "^26.6.4",
     "rimraf": "^6.1.3",
-    "rolldown": "^1.2.4",
+    "rolldown": "^1.2.12",
     "typescript": "^7.0.2",
-    "vitest": "^4.1.10"
+    "vitest": "^5.0.3"
   },
   "sideEffects": false,
   "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/src/http1/encode.ts

@@ -50,6 +50,7 @@ export function splitTarget(
   // Both capture groups are mandatory in the regex above (neither is
   // `?`-quantified), so a successful match always populates them — an empty
   // string is possible, `undefined` is not.
+  // biome-ignore lint/style/noNonNullAssertion: mandatory capture group, per the comment above.
   const rawAuthority = match[1]!;
   if (rawAuthority === "") {
     throw new HttpParseError(`url has no authority: ${JSON.stringify(url)}`);
@@ -60,6 +61,7 @@ export function splitTarget(
   const authority = at === -1 ? rawAuthority : rawAuthority.slice(at + 1);
   assertValidHost(authority);
 
+  // biome-ignore lint/style/noNonNullAssertion: mandatory capture group, per the comment above.
   const rawTarget = match[2]!;
   const target = rawTarget === "" ? "/" : rawTarget.startsWith("/") ? rawTarget : `/${rawTarget}`;
   assertValidTarget(target);

package/src/http1/headers.ts

@@ -199,6 +199,7 @@ export function parseContentLength(values: string[]): number | undefined {
   // build, not in this package's own (which does not enable the flag, so it
   // cannot catch the regression). It was lost once already, in a rebase that
   // resolved toward a refactor of this function.
+  // biome-ignore lint/style/noNonNullAssertion: load-bearing for consumers building with noUncheckedIndexedAccess -- see above; it was lost once already.
   const raw = [...unique][0]!;
   if (!/^\d{1,15}$/.test(raw)) {
     throw new HttpParseError(`invalid Content-Length: ${JSON.stringify(raw)}`);