@connexis/transport-websocket 1.0.1 → 1.0.2

package/dist/index.d.mts

@@ -3,6 +3,7 @@ import { Transport, Serializer, ConnectionState, TransportCapabilities } from '@
 interface WebSocketTransportOptions {
     protocols?: string | string[];
     serializer?: Serializer;
+    authToken?: string | (() => string | Promise<string>);
 }
 declare class WebSocketTransport implements Transport {
     private url;

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import { Transport, Serializer, ConnectionState, TransportCapabilities } from '@
 interface WebSocketTransportOptions {
     protocols?: string | string[];
     serializer?: Serializer;
+    authToken?: string | (() => string | Promise<string>);
 }
 declare class WebSocketTransport implements Transport {
     private url;

package/dist/index.js

@@ -49,10 +49,16 @@ var WebSocketTransport = class _WebSocketTransport {
       return;
     }
     this.updateState("connecting");
+    let connectionUrl = this.url;
+    if (this.options.authToken) {
+      const token = typeof this.options.authToken === "function" ? await this.options.authToken() : this.options.authToken;
+      const separator = connectionUrl.includes("?") ? "&" : "?";
+      connectionUrl = `${connectionUrl}${separator}token=${encodeURIComponent(token)}`;
+    }
     return new Promise((resolve, reject) => {
       try {
         const protocols = this.options.protocols;
-        this.ws = protocols ? new WebSocket(this.url, protocols) : new WebSocket(this.url);
+        this.ws = protocols ? new WebSocket(connectionUrl, protocols) : new WebSocket(connectionUrl);
       } catch (err) {
         this.updateState("error", err);
         reject(err);

package/dist/index.mjs

@@ -25,10 +25,16 @@ var WebSocketTransport = class _WebSocketTransport {
       return;
     }
     this.updateState("connecting");
+    let connectionUrl = this.url;
+    if (this.options.authToken) {
+      const token = typeof this.options.authToken === "function" ? await this.options.authToken() : this.options.authToken;
+      const separator = connectionUrl.includes("?") ? "&" : "?";
+      connectionUrl = `${connectionUrl}${separator}token=${encodeURIComponent(token)}`;
+    }
     return new Promise((resolve, reject) => {
       try {
         const protocols = this.options.protocols;
-        this.ws = protocols ? new WebSocket(this.url, protocols) : new WebSocket(this.url);
+        this.ws = protocols ? new WebSocket(connectionUrl, protocols) : new WebSocket(connectionUrl);
       } catch (err) {
         this.updateState("error", err);
         reject(err);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connexis/transport-websocket",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "WebSocket transport for @connexis",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -13,7 +13,7 @@
     }
   },
   "dependencies": {
-    "@connexis/core": "1.0.1"
+    "@connexis/core": "1.0.2"
   },
   "devDependencies": {
     "typescript": "^5.5.2"

package/src/__tests__/websocket-transport.test.ts

@@ -0,0 +1,85 @@
+import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
+import { WebSocketTransport } from '../index.js';
+
+// Setup Mock WebSocket class
+class MockWebSocket {
+  public static lastInstance: MockWebSocket | null = null;
+  public onopen: (() => void) | null = null;
+  public onmessage: ((e: { data: any }) => void) | null = null;
+  public onerror: ((e: any) => void) | null = null;
+  public onclose: (() => void) | null = null;
+  public url: string;
+  public protocols: string | string[] | undefined;
+  public readyState = 1; // OPEN
+
+  constructor(url: string, protocols?: string | string[]) {
+    this.url = url;
+    this.protocols = protocols;
+    MockWebSocket.lastInstance = this;
+
+    // Simulate async connection success
+    setTimeout(() => {
+      this.onopen?.();
+    }, 10);
+  }
+
+  send(_data: any) {}
+  close() {
+    setTimeout(() => {
+      this.onclose?.();
+    }, 10);
+  }
+}
+
+describe('WebSocketTransport Auth', () => {
+  beforeEach(() => {
+    vi.stubGlobal('WebSocket', MockWebSocket);
+    MockWebSocket.lastInstance = null;
+  });
+
+  afterEach(() => {
+    vi.unstubAllGlobals();
+    vi.restoreAllMocks();
+  });
+
+  it('should append token as query parameter for static authToken', async () => {
+    const transport = new WebSocketTransport('ws://localhost/ws', {
+      authToken: 'static-socket-token'
+    });
+
+    await transport.connect();
+
+    expect(MockWebSocket.lastInstance).not.toBeNull();
+    expect(MockWebSocket.lastInstance!.url).toBe('ws://localhost/ws?token=static-socket-token');
+
+    await transport.disconnect();
+  });
+
+  it('should append token correctly using & if URL already contains query params', async () => {
+    const transport = new WebSocketTransport('ws://localhost/ws?foo=bar', {
+      authToken: 'static-socket-token'
+    });
+
+    await transport.connect();
+
+    expect(MockWebSocket.lastInstance).not.toBeNull();
+    expect(MockWebSocket.lastInstance!.url).toBe('ws://localhost/ws?foo=bar&token=static-socket-token');
+
+    await transport.disconnect();
+  });
+
+  it('should resolve and append token for dynamic async getAuthToken callback', async () => {
+    const mockGetToken = vi.fn().mockResolvedValue('dynamic-socket-token');
+    const transport = new WebSocketTransport('ws://localhost/ws', {
+      authToken: mockGetToken
+    });
+
+    await transport.connect();
+
+    expect(mockGetToken).toHaveBeenCalled();
+    expect(MockWebSocket.lastInstance).not.toBeNull();
+    expect(MockWebSocket.lastInstance!.url).toBe('ws://localhost/ws?token=dynamic-socket-token');
+
+    await transport.disconnect();
+  });
+});

package/src/index.ts

@@ -3,6 +3,7 @@ import { Transport, ConnectionState, TransportCapabilities, Serializer } from '@
 export interface WebSocketTransportOptions {
   protocols?: string | string[];
   serializer?: Serializer;
+  authToken?: string | (() => string | Promise<string>);
 }
 
 const defaultSerializer: Serializer = {
@@ -37,10 +38,19 @@ export class WebSocketTransport implements Transport {
 
     this.updateState('connecting');
 
+    let connectionUrl = this.url;
+    if (this.options.authToken) {
+      const token = typeof this.options.authToken === 'function'
+        ? await this.options.authToken()
+        : this.options.authToken;
+      const separator = connectionUrl.includes('?') ? '&' : '?';
+      connectionUrl = `${connectionUrl}${separator}token=${encodeURIComponent(token)}`;
+    }
+
     return new Promise<void>((resolve, reject) => {
       try {
         const protocols = this.options.protocols;
-        this.ws = protocols ? new WebSocket(this.url, protocols) : new WebSocket(this.url);
+        this.ws = protocols ? new WebSocket(connectionUrl, protocols) : new WebSocket(connectionUrl);
       } catch (err) {
         this.updateState('error', err as Error);
         reject(err);