@opentunnel/client 0.2.0 → 0.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentunnel/client",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "OpenTunnel SDK for Bun: expose local services through a blind TLS tunnel",
   "license": "MIT",
   "repository": {
@@ -28,7 +28,7 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@opentunnel/protocol": "0.2.0",
+    "@opentunnel/protocol": "0.2.2",
     "effect": "4.0.0-rc.112"
   },
   "devDependencies": {

package/src/effect/api.ts

@@ -1,9 +1,13 @@
 import { Effect, Layer, Context } from "effect";
 import { FetchHttpClient, HttpClient, HttpClientRequest } from "effect/unstable/http";
+import pkg from "../../package.json" with { type: "json" };
 import { HttpApiClient } from "effect/unstable/httpapi";
 import { Api } from "@opentunnel/protocol/api/api";
 import { Tunnel } from "@opentunnel/protocol/tunnel";
 
+/** How the SDK identifies itself to the server, on API calls and the bridge. */
+export const USER_AGENT = `opentunnel-sdk/${pkg.version}`;
+
 type Client = HttpApiClient.ForApi<typeof Api>;
 
 interface OpenTunnelApi {
@@ -18,7 +22,9 @@ export class OpenTunnelApiClient extends Context.Service<OpenTunnelApiClient, Op
     return Layer.effect(
       OpenTunnelApiClient,
       Effect.gen(function* () {
-        const httpClient = yield* HttpClient.HttpClient;
+        const httpClient = (yield* HttpClient.HttpClient).pipe(
+          HttpClient.mapRequest(HttpClientRequest.setHeader("user-agent", USER_AGENT)),
+        );
         const client = yield* HttpApiClient.makeWith(Api, {
           baseUrl: options.api,
           httpClient,

package/src/effect/tunnel.ts

@@ -4,6 +4,13 @@ import { Duplex } from "node:stream";
 import * as Tls from "node:tls";
 import { BridgeProtocol } from "@opentunnel/protocol/bridge-protocol";
 import { Names } from "@opentunnel/protocol/names";
+import { USER_AGENT } from "./api.js";
+
+/** Bun's WebSocket also takes options with request headers, which the DOM typings don't know about. */
+const BunWebSocket = WebSocket as unknown as new (
+  url: URL,
+  options: { readonly protocols: string[]; readonly headers: Record<string, string> },
+) => WebSocket;
 import type {
   OpenTunnelClientEvent,
   OpenTunnelIdentity,
@@ -308,7 +315,10 @@ class Session {
         this.options.api,
       );
       url.protocol = url.protocol === "https:" ? "wss:" : "ws:";
-      const socket = new WebSocket(url, BridgeProtocol.WEBSOCKET_SUBPROTOCOL);
+      const socket = new BunWebSocket(url, {
+        protocols: [BridgeProtocol.WEBSOCKET_SUBPROTOCOL],
+        headers: { "user-agent": USER_AGENT },
+      });
       socket.binaryType = "arraybuffer";
       this.socket = socket;
       this.attachTimeout = setTimeout(