@moq/web-transport 0.1.0 → 0.1.1

package/README.md

@@ -1,63 +1,29 @@
 # @moq/web-transport
 
-WebTransport for Node.js, powered by QUIC and HTTP/3.
+WebTransport for Node.js, powered by native QUIC/HTTP3 via NAPI-RS.
 
-This package provides both a client-side `WebTransport` polyfill and a server implementation.
+Provides a custom client and server API for setup, then exposes the standard [W3C WebTransport API](https://www.w3.org/TR/webtransport/) for streams, datagrams, and session lifecycle.
 
-## Install
+## Installation
 
 ```bash
-npm install @moq/web-transport
+bun add @moq/web-transport
 ```
 
 ## Client
 
-The `Session` class implements the [W3C WebTransport API](https://www.w3.org/TR/webtransport/).
+Connect to a WebTransport server using the `Session` class, which implements the W3C `WebTransport` interface:
 
 ```ts
 import Session from "@moq/web-transport";
 
-const session = new Session("https://example.com:4443");
+const session = new Session("https://example.com:4443/path");
 await session.ready;
 
-// Bidirectional streams
-const bidi = await session.createBidirectionalStream();
-const writer = bidi.writable.getWriter();
-await writer.write(new Uint8Array([1, 2, 3]));
-await writer.close();
-
-// Unidirectional streams
-const uni = await session.createUnidirectionalStream();
-const uniWriter = uni.getWriter();
-await uniWriter.write(new Uint8Array([4, 5, 6]));
-await uniWriter.close();
-
-// Datagrams
-const dgWriter = session.datagrams.writable.getWriter();
-await dgWriter.write(new Uint8Array([7, 8, 9]));
-
-// Incoming streams
-for await (const recv of session.incomingUnidirectionalStreams) {
-	const reader = recv.getReader();
-	// read from reader...
-}
-
-session.close();
+// Use the standard W3C WebTransport API from here on
 ```
 
-### Polyfill
-
-Use `install()` to register `Session` as the global `WebTransport` if one doesn't already exist:
-
-```ts
-import { install } from "@moq/web-transport";
-install();
-
-// Now use the standard WebTransport API
-const session = new WebTransport("https://example.com:4443");
-```
-
-### Certificate Options
+### Certificate options
 
 ```ts
 // Skip certificate verification (testing only!)
@@ -66,32 +32,110 @@ const session = new Session("https://localhost:4443", {
 });
 
 // Pin to specific certificate hashes
-const session = new Session("https://example.com:4443", {
+const session = new Session("https://localhost:4443", {
 	serverCertificateHashes: [
-		{ algorithm: "sha-256", value: hashBuffer },
+		{ algorithm: "sha-256", value: certHash },
 	],
 });
 ```
 
+### Polyfill
+
+Install `Session` as the global `WebTransport` for libraries that expect the browser API:
+
+```ts
+import { install } from "@moq/web-transport";
+
+install(); // globalThis.WebTransport = Session (no-op if already defined)
+```
+
 ## Server
 
+Use `Server` to accept incoming connections. Each `Request` can be accepted (returning a W3C `Session`) or rejected:
+
 ```ts
 import { Server } from "@moq/web-transport";
 import fs from "node:fs";
 
-const certPem = fs.readFileSync("cert.pem");
-const keyPem = fs.readFileSync("key.pem");
+const cert = fs.readFileSync("cert.pem");
+const key = fs.readFileSync("key.pem");
 
-const server = Server.bind("[::]:4443", certPem, keyPem);
+const server = Server.bind("[::]:4443", cert, key);
 
 while (true) {
 	const request = await server.accept();
 	if (!request) break;
 
 	const url = await request.url;
-	console.log("incoming request:", url);
+	console.log("incoming session:", url);
+
+	const session = await request.ok(); // or request.reject(404)
 
-	const session = await request.ok();
-	// Use session just like the client-side API
+	// Use the standard W3C WebTransport API from here on
+	handleSession(session);
 }
+
+// Stop accepting new connections
+server.close();
 ```
+
+## W3C WebTransport API
+
+Once you have a `Session` (client or server-side), the API follows the [W3C WebTransport spec](https://www.w3.org/TR/webtransport/):
+
+### Bidirectional streams
+
+```ts
+// Open a bidirectional stream
+const stream = await session.createBidirectionalStream();
+const writer = stream.writable.getWriter();
+await writer.write(new Uint8Array([1, 2, 3]));
+await writer.close();
+
+// Accept incoming bidirectional streams
+const reader = session.incomingBidirectionalStreams.getReader();
+const { value: incoming } = await reader.read();
+const data = await new Response(incoming.readable).arrayBuffer();
+```
+
+### Unidirectional streams
+
+```ts
+// Open a unidirectional stream
+const writable = await session.createUnidirectionalStream();
+const writer = writable.getWriter();
+await writer.write(new TextEncoder().encode("hello"));
+await writer.close();
+
+// Accept incoming unidirectional streams
+const reader = session.incomingUnidirectionalStreams.getReader();
+const { value: readable } = await reader.read();
+const text = await new Response(readable).text();
+```
+
+### Datagrams
+
+```ts
+// Send datagrams
+const writer = session.datagrams.writable.getWriter();
+await writer.write(new Uint8Array([0x01, 0x02]));
+
+// Receive datagrams
+const reader = session.datagrams.readable.getReader();
+const { value: datagram } = await reader.read();
+```
+
+### Closing
+
+```ts
+// Close gracefully
+session.close({ closeCode: 0, reason: "done" });
+
+// Wait for the session to close
+const info = await session.closed;
+console.log(info.closeCode, info.reason);
+```
+
+## License
+
+MIT OR Apache-2.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@moq/web-transport",
-	"version": "0.1.0",
+	"version": "0.1.1",
 	"description": "WebTransport polyfill for Node.js via QUIC/HTTP3",
 	"type": "module",
 	"license": "(MIT OR Apache-2.0)",
@@ -36,11 +36,11 @@
 		"@types/node": "^24.3.0"
 	},
 	"optionalDependencies": {
-		"@moq/web-transport-darwin-x64": "0.1.0",
-		"@moq/web-transport-darwin-arm64": "0.1.0",
-		"@moq/web-transport-win32-x64-msvc": "0.1.0",
-		"@moq/web-transport-linux-x64-gnu": "0.1.0",
-		"@moq/web-transport-linux-arm64-gnu": "0.1.0"
+		"@moq/web-transport-darwin-x64": "0.1.1",
+		"@moq/web-transport-darwin-arm64": "0.1.1",
+		"@moq/web-transport-win32-x64-msvc": "0.1.1",
+		"@moq/web-transport-linux-x64-gnu": "0.1.1",
+		"@moq/web-transport-linux-arm64-gnu": "0.1.1"
 	},
 	"keywords": [
 		"webtransport",