@ldtr/nestjs-webtransport 0.0.1 → 0.0.2

package/README.md

@@ -26,15 +26,10 @@ import { readFile } from "node:fs/promises"
 
 @WebTransportServer({ name: "main" })
 export class MainWebTransportServer implements WebTransportServerOptionsFactory {
-    constructor(
-        private readonly configService: ConfigService
-    ) {
-    }
-
     async options(): Promise<HttpServerInit> {
         const cert = await readFile("./certs/cert.pem", { encoding: "utf-8" })
         const privKey = await readFile("./certs/key.pem", { encoding: "utf-8" })
-        const secret = this.configService.secret
+        const secret = "change-me"
         return {
             port: 3001,
             host: "0.0.0.0",
@@ -48,21 +43,58 @@ export class MainWebTransportServer implements WebTransportServerOptionsFactory
 
 @WebTransportGateway({ server: "main", path: "/events" })
 export class EventsGateway implements WebTransportGatewayLifecycle {
-    onSession(session: WtSession): void {
-        // new WebTransport session
+    async onSession(session: WtSession): Promise<void> {
+        console.log("new WebTransport session")
+        try {
+            // Create a unidirectional (Write/Only) stream from the server to the client.
+            const stream = await session.createStreamWO()
+            
+            // This stream can be used to send data, but it cannot read data back.
+            await stream.write(new TextEncoder().encode("Hello from the server."))
+
+            await stream.closeWritable()
+        } catch (error) {
+            console.error(error)
+        }
+    }
+    
+    async onStreamRW(stream: WtStreamRW): Promise<void> {
+        console.log("New bidirectional stream opened by client (Read/Write).")
+        await this.readStream(stream,
+            chunk => console.log(`Received chunk: ${chunk.length} byte(s).`),
+            async () => {
+                await stream.write(new TextEncoder().encode("Server received all chunks."))
+                await stream.closeWritable()
+            }
+        )
     }
 
-    onStreamRW(stream: WtStreamRW): void {
-        // new bidirectional stream
+    async onStreamRO(stream: WtStreamRO): Promise<void> {
+        console.log("New unidirectional stream opened by client (Read/Only).")
+        await this.readStream(stream)
     }
+    
+    private async readStream(
+        stream: WtStreamRW | WtStreamRO,
+        onChunk?: (chunk: Uint8Array) => void | Promise<void>,
+        onClosed?: () => void | Promise<void>
+    ): Promise<void> {
+        try {
+            // The stream must be read immediately to consume incoming client data.
+            for await (const chunk of stream.read())
+                void onChunk?.(chunk)
 
-    onStreamRO(stream: WtStreamRO): void {
-        // new unidirectional stream
+            // Client closed stream
+            await onClosed?.()
+        } catch (error) {
+            console.error("Failed to read stream:", error)
+            throw error
+        }
     }
 }
 ```
 
-Then import them in your application with the ```WebTransportModule```:
+Then import them in your application with the `WebTransportModule`:
 
 ```ts
 import { WebTransportModule } from "@ldtr/nestjs-webtransport"
@@ -70,7 +102,7 @@ import { Module } from "@nestjs/common"
 
 @Module({
     imports: [
-      WebTransportModule],
+        WebTransportModule],
     providers: [
         EventsGateway,
         MainWebTransportServer]

package/package.json

@@ -1,15 +1,14 @@
- {
+{
     "name": "@ldtr/nestjs-webtransport",
-    "version": "0.0.1",
+    "version": "0.0.2",
+    "description": "NestJS module for creating WebTransport servers and gateways.",
     "type": "module",
     "files": ["dist"],
     "main": "./dist/index.cjs",
-    "module": "./dist/index.js",
-    "types": "./dist/index.d.ts",
+    "types": "./dist/index.d.cts",
     "exports": {
         ".": {
-            "types": "./dist/index.d.ts",
-            "import": "./dist/index.js",
+            "types": "./dist/index.d.cts",
             "require": "./dist/index.cjs"
         }
     },
@@ -21,12 +20,24 @@
         "@fails-components/webtransport": "^1.6.3",
         "@fails-components/webtransport-transport-http3-quiche": "^1.6.3",
         "reflect-metadata": "^0.1.13",
-        "tslib": "^2.3.0",
+        "tslib": "^2.3.0"
+    },
+    "devDependencies": {
         "tsdown": "^0.22.3",
         "typescript": "^6.0.3"
     },
     "peerDependencies": {
         "@nestjs/common": "^11.0.0",
         "@nestjs/core": "^11.0.0"
-    }
-}
+    },
+    "keywords": [
+        "nestjs",
+        "webtransport",
+        "webtransport-server",
+        "http3",
+        "quic",
+        "gateway",
+        "module",
+        "typescript"
+    ]
+}