@chainstream-io/centrifuge 1.0.4 → 1.0.5

package/build/centrifuge.d.ts

@@ -75,16 +75,9 @@ export declare class Centrifuge extends Centrifuge_base {
     setHeaders(headers: {
         [key: string]: string;
     }): void;
-    /** setHttpHeaders allows setting HTTP headers for WebSocket handshake.
-     * Only works in Node.js environment with 'ws' library.
-     * Browser WebSocket API does not support custom headers. */
-    setHttpHeaders(headers: {
-        [key: string]: string;
-    }): void;
-    /** setWebsocket allows setting WebSocket implementation at runtime.
-     * Useful for lazy-loading 'ws' library in Node.js environment.
-     * Must be called before connect(). */
-    setWebsocket(websocket: any): void;
+    /** setWsProtocolToken allows setting token to pass via Sec-WebSocket-Protocol header.
+     * Works in both browser and Node.js environments. */
+    setWsProtocolToken(token: string): void;
     /** send asynchronous data to a server (without any response from a server
      * expected, see rpc method if you need response). */
     send(data: any): Promise<void>;

package/build/index.js

@@ -1370,32 +1370,20 @@ class WebsocketTransport {
         return this.options.websocket !== undefined && this.options.websocket !== null;
     }
     initialize(protocol, callbacks) {
-        let subProtocol = '';
+        // Build protocols array for Sec-WebSocket-Protocol header
+        const protocols = [];
         if (protocol === 'protobuf') {
-            subProtocol = 'centrifuge-protobuf';
+            protocols.push('centrifuge-protobuf');
         }
-        // Check if we have HTTP headers to pass (only works in Node.js with 'ws' library)
-        // Browser WebSocket API does not support custom headers
-        const httpHeaders = this.options.httpHeaders;
-        const hasHttpHeaders = httpHeaders && Object.keys(httpHeaders).length > 0;
-        if (subProtocol !== '') {
-            if (hasHttpHeaders) {
-                // Node.js 'ws' library supports third argument with headers
-                this._transport = new this.options.websocket(this.endpoint, subProtocol, { headers: httpHeaders });
-            }
-            else {
-                this._transport = new this.options.websocket(this.endpoint, subProtocol);
-            }
-        }
-        else {
-            if (hasHttpHeaders) {
-                // Node.js 'ws' library supports third argument with headers
-                this._transport = new this.options.websocket(this.endpoint, undefined, { headers: httpHeaders });
-            }
-            else {
-                this._transport = new this.options.websocket(this.endpoint);
-            }
+        // Add token via Sec-WebSocket-Protocol header for authentication
+        // Format: "Bearer {token}" - server extracts token from this sub-protocol
+        const wsProtocolToken = this.options.wsProtocolToken;
+        if (wsProtocolToken) {
+            protocols.push(`Bearer ${wsProtocolToken}`);
         }
+        // Determine the protocols argument
+        const protocolsArg = protocols.length > 0 ? protocols : undefined;
+        this._transport = new this.options.websocket(this.endpoint, protocolsArg);
         if (protocol === 'protobuf') {
             this._transport.binaryType = 'arraybuffer';
         }
@@ -2056,7 +2044,6 @@ class JsonCodec {
 
 const defaults = {
     headers: {},
-    httpHeaders: {},
     token: '',
     getToken: null,
     data: null,
@@ -2076,6 +2063,7 @@ const defaults = {
     timeout: 5000,
     maxServerPingDelay: 10000,
     networkEventTarget: null,
+    wsProtocolToken: '',
 };
 class UnauthorizedError extends Error {
     constructor(message) {
@@ -2221,17 +2209,10 @@ class Centrifuge extends EventEmitter$1 {
     setHeaders(headers) {
         this._config.headers = headers;
     }
-    /** setHttpHeaders allows setting HTTP headers for WebSocket handshake.
-     * Only works in Node.js environment with 'ws' library.
-     * Browser WebSocket API does not support custom headers. */
-    setHttpHeaders(headers) {
-        this._config.httpHeaders = headers;
-    }
-    /** setWebsocket allows setting WebSocket implementation at runtime.
-     * Useful for lazy-loading 'ws' library in Node.js environment.
-     * Must be called before connect(). */
-    setWebsocket(websocket) {
-        this._config.websocket = websocket;
+    /** setWsProtocolToken allows setting token to pass via Sec-WebSocket-Protocol header.
+     * Works in both browser and Node.js environments. */
+    setWsProtocolToken(token) {
+        this._config.wsProtocolToken = token;
     }
     /** send asynchronous data to a server (without any response from a server
      * expected, see rpc method if you need response). */
@@ -2607,7 +2588,7 @@ class Centrifuge extends EventEmitter$1 {
                 this._debug('client will use websocket');
                 this._transport = new WebsocketTransport(this._endpoint, {
                     websocket: websocket,
-                    httpHeaders: this._config.httpHeaders
+                    wsProtocolToken: this._config.wsProtocolToken
                 });
                 if (!this._transport.supported()) {
                     throw new Error('WebSocket constructor not found, make sure it is available globally or passed as a dependency in Centrifuge options');
@@ -2631,7 +2612,7 @@ class Centrifuge extends EventEmitter$1 {
                     this._debug('trying websocket transport');
                     this._transport = new WebsocketTransport(transportEndpoint, {
                         websocket: websocket,
-                        httpHeaders: this._config.httpHeaders
+                        wsProtocolToken: this._config.wsProtocolToken
                     });
                     if (!this._transport.supported()) {
                         this._debug('websocket transport not available');

package/build/index.mjs

@@ -1368,32 +1368,20 @@ class WebsocketTransport {
         return this.options.websocket !== undefined && this.options.websocket !== null;
     }
     initialize(protocol, callbacks) {
-        let subProtocol = '';
+        // Build protocols array for Sec-WebSocket-Protocol header
+        const protocols = [];
         if (protocol === 'protobuf') {
-            subProtocol = 'centrifuge-protobuf';
+            protocols.push('centrifuge-protobuf');
         }
-        // Check if we have HTTP headers to pass (only works in Node.js with 'ws' library)
-        // Browser WebSocket API does not support custom headers
-        const httpHeaders = this.options.httpHeaders;
-        const hasHttpHeaders = httpHeaders && Object.keys(httpHeaders).length > 0;
-        if (subProtocol !== '') {
-            if (hasHttpHeaders) {
-                // Node.js 'ws' library supports third argument with headers
-                this._transport = new this.options.websocket(this.endpoint, subProtocol, { headers: httpHeaders });
-            }
-            else {
-                this._transport = new this.options.websocket(this.endpoint, subProtocol);
-            }
-        }
-        else {
-            if (hasHttpHeaders) {
-                // Node.js 'ws' library supports third argument with headers
-                this._transport = new this.options.websocket(this.endpoint, undefined, { headers: httpHeaders });
-            }
-            else {
-                this._transport = new this.options.websocket(this.endpoint);
-            }
+        // Add token via Sec-WebSocket-Protocol header for authentication
+        // Format: "Bearer {token}" - server extracts token from this sub-protocol
+        const wsProtocolToken = this.options.wsProtocolToken;
+        if (wsProtocolToken) {
+            protocols.push(`Bearer ${wsProtocolToken}`);
         }
+        // Determine the protocols argument
+        const protocolsArg = protocols.length > 0 ? protocols : undefined;
+        this._transport = new this.options.websocket(this.endpoint, protocolsArg);
         if (protocol === 'protobuf') {
             this._transport.binaryType = 'arraybuffer';
         }
@@ -2054,7 +2042,6 @@ class JsonCodec {
 
 const defaults = {
     headers: {},
-    httpHeaders: {},
     token: '',
     getToken: null,
     data: null,
@@ -2074,6 +2061,7 @@ const defaults = {
     timeout: 5000,
     maxServerPingDelay: 10000,
     networkEventTarget: null,
+    wsProtocolToken: '',
 };
 class UnauthorizedError extends Error {
     constructor(message) {
@@ -2219,17 +2207,10 @@ class Centrifuge extends EventEmitter$1 {
     setHeaders(headers) {
         this._config.headers = headers;
     }
-    /** setHttpHeaders allows setting HTTP headers for WebSocket handshake.
-     * Only works in Node.js environment with 'ws' library.
-     * Browser WebSocket API does not support custom headers. */
-    setHttpHeaders(headers) {
-        this._config.httpHeaders = headers;
-    }
-    /** setWebsocket allows setting WebSocket implementation at runtime.
-     * Useful for lazy-loading 'ws' library in Node.js environment.
-     * Must be called before connect(). */
-    setWebsocket(websocket) {
-        this._config.websocket = websocket;
+    /** setWsProtocolToken allows setting token to pass via Sec-WebSocket-Protocol header.
+     * Works in both browser and Node.js environments. */
+    setWsProtocolToken(token) {
+        this._config.wsProtocolToken = token;
     }
     /** send asynchronous data to a server (without any response from a server
      * expected, see rpc method if you need response). */
@@ -2605,7 +2586,7 @@ class Centrifuge extends EventEmitter$1 {
                 this._debug('client will use websocket');
                 this._transport = new WebsocketTransport(this._endpoint, {
                     websocket: websocket,
-                    httpHeaders: this._config.httpHeaders
+                    wsProtocolToken: this._config.wsProtocolToken
                 });
                 if (!this._transport.supported()) {
                     throw new Error('WebSocket constructor not found, make sure it is available globally or passed as a dependency in Centrifuge options');
@@ -2629,7 +2610,7 @@ class Centrifuge extends EventEmitter$1 {
                     this._debug('trying websocket transport');
                     this._transport = new WebsocketTransport(transportEndpoint, {
                         websocket: websocket,
-                        httpHeaders: this._config.httpHeaders
+                        wsProtocolToken: this._config.wsProtocolToken
                     });
                     if (!this._transport.supported()) {
                         this._debug('websocket transport not available');

package/build/protobuf/centrifuge.d.ts

@@ -75,16 +75,9 @@ export declare class Centrifuge extends Centrifuge_base {
     setHeaders(headers: {
         [key: string]: string;
     }): void;
-    /** setHttpHeaders allows setting HTTP headers for WebSocket handshake.
-     * Only works in Node.js environment with 'ws' library.
-     * Browser WebSocket API does not support custom headers. */
-    setHttpHeaders(headers: {
-        [key: string]: string;
-    }): void;
-    /** setWebsocket allows setting WebSocket implementation at runtime.
-     * Useful for lazy-loading 'ws' library in Node.js environment.
-     * Must be called before connect(). */
-    setWebsocket(websocket: any): void;
+    /** setWsProtocolToken allows setting token to pass via Sec-WebSocket-Protocol header.
+     * Works in both browser and Node.js environments. */
+    setWsProtocolToken(token: string): void;
     /** send asynchronous data to a server (without any response from a server
      * expected, see rpc method if you need response). */
     send(data: any): Promise<void>;

package/build/protobuf/index.js

@@ -1372,32 +1372,20 @@ class WebsocketTransport {
         return this.options.websocket !== undefined && this.options.websocket !== null;
     }
     initialize(protocol, callbacks) {
-        let subProtocol = '';
+        // Build protocols array for Sec-WebSocket-Protocol header
+        const protocols = [];
         if (protocol === 'protobuf') {
-            subProtocol = 'centrifuge-protobuf';
-        }
-        // Check if we have HTTP headers to pass (only works in Node.js with 'ws' library)
-        // Browser WebSocket API does not support custom headers
-        const httpHeaders = this.options.httpHeaders;
-        const hasHttpHeaders = httpHeaders && Object.keys(httpHeaders).length > 0;
-        if (subProtocol !== '') {
-            if (hasHttpHeaders) {
-                // Node.js 'ws' library supports third argument with headers
-                this._transport = new this.options.websocket(this.endpoint, subProtocol, { headers: httpHeaders });
-            }
-            else {
-                this._transport = new this.options.websocket(this.endpoint, subProtocol);
-            }
+            protocols.push('centrifuge-protobuf');
         }
-        else {
-            if (hasHttpHeaders) {
-                // Node.js 'ws' library supports third argument with headers
-                this._transport = new this.options.websocket(this.endpoint, undefined, { headers: httpHeaders });
-            }
-            else {
-                this._transport = new this.options.websocket(this.endpoint);
-            }
+        // Add token via Sec-WebSocket-Protocol header for authentication
+        // Format: "Bearer {token}" - server extracts token from this sub-protocol
+        const wsProtocolToken = this.options.wsProtocolToken;
+        if (wsProtocolToken) {
+            protocols.push(`Bearer ${wsProtocolToken}`);
         }
+        // Determine the protocols argument
+        const protocolsArg = protocols.length > 0 ? protocols : undefined;
+        this._transport = new this.options.websocket(this.endpoint, protocolsArg);
         if (protocol === 'protobuf') {
             this._transport.binaryType = 'arraybuffer';
         }
@@ -2058,7 +2046,6 @@ class JsonCodec {
 
 const defaults = {
     headers: {},
-    httpHeaders: {},
     token: '',
     getToken: null,
     data: null,
@@ -2078,6 +2065,7 @@ const defaults = {
     timeout: 5000,
     maxServerPingDelay: 10000,
     networkEventTarget: null,
+    wsProtocolToken: '',
 };
 class UnauthorizedError extends Error {
     constructor(message) {
@@ -2223,17 +2211,10 @@ class Centrifuge extends EventEmitter$1 {
     setHeaders(headers) {
         this._config.headers = headers;
     }
-    /** setHttpHeaders allows setting HTTP headers for WebSocket handshake.
-     * Only works in Node.js environment with 'ws' library.
-     * Browser WebSocket API does not support custom headers. */
-    setHttpHeaders(headers) {
-        this._config.httpHeaders = headers;
-    }
-    /** setWebsocket allows setting WebSocket implementation at runtime.
-     * Useful for lazy-loading 'ws' library in Node.js environment.
-     * Must be called before connect(). */
-    setWebsocket(websocket) {
-        this._config.websocket = websocket;
+    /** setWsProtocolToken allows setting token to pass via Sec-WebSocket-Protocol header.
+     * Works in both browser and Node.js environments. */
+    setWsProtocolToken(token) {
+        this._config.wsProtocolToken = token;
     }
     /** send asynchronous data to a server (without any response from a server
      * expected, see rpc method if you need response). */
@@ -2609,7 +2590,7 @@ class Centrifuge extends EventEmitter$1 {
                 this._debug('client will use websocket');
                 this._transport = new WebsocketTransport(this._endpoint, {
                     websocket: websocket,
-                    httpHeaders: this._config.httpHeaders
+                    wsProtocolToken: this._config.wsProtocolToken
                 });
                 if (!this._transport.supported()) {
                     throw new Error('WebSocket constructor not found, make sure it is available globally or passed as a dependency in Centrifuge options');
@@ -2633,7 +2614,7 @@ class Centrifuge extends EventEmitter$1 {
                     this._debug('trying websocket transport');
                     this._transport = new WebsocketTransport(transportEndpoint, {
                         websocket: websocket,
-                        httpHeaders: this._config.httpHeaders
+                        wsProtocolToken: this._config.wsProtocolToken
                     });
                     if (!this._transport.supported()) {
                         this._debug('websocket transport not available');

package/build/protobuf/index.mjs

@@ -1370,32 +1370,20 @@ class WebsocketTransport {
         return this.options.websocket !== undefined && this.options.websocket !== null;
     }
     initialize(protocol, callbacks) {
-        let subProtocol = '';
+        // Build protocols array for Sec-WebSocket-Protocol header
+        const protocols = [];
         if (protocol === 'protobuf') {
-            subProtocol = 'centrifuge-protobuf';
-        }
-        // Check if we have HTTP headers to pass (only works in Node.js with 'ws' library)
-        // Browser WebSocket API does not support custom headers
-        const httpHeaders = this.options.httpHeaders;
-        const hasHttpHeaders = httpHeaders && Object.keys(httpHeaders).length > 0;
-        if (subProtocol !== '') {
-            if (hasHttpHeaders) {
-                // Node.js 'ws' library supports third argument with headers
-                this._transport = new this.options.websocket(this.endpoint, subProtocol, { headers: httpHeaders });
-            }
-            else {
-                this._transport = new this.options.websocket(this.endpoint, subProtocol);
-            }
+            protocols.push('centrifuge-protobuf');
         }
-        else {
-            if (hasHttpHeaders) {
-                // Node.js 'ws' library supports third argument with headers
-                this._transport = new this.options.websocket(this.endpoint, undefined, { headers: httpHeaders });
-            }
-            else {
-                this._transport = new this.options.websocket(this.endpoint);
-            }
+        // Add token via Sec-WebSocket-Protocol header for authentication
+        // Format: "Bearer {token}" - server extracts token from this sub-protocol
+        const wsProtocolToken = this.options.wsProtocolToken;
+        if (wsProtocolToken) {
+            protocols.push(`Bearer ${wsProtocolToken}`);
         }
+        // Determine the protocols argument
+        const protocolsArg = protocols.length > 0 ? protocols : undefined;
+        this._transport = new this.options.websocket(this.endpoint, protocolsArg);
         if (protocol === 'protobuf') {
             this._transport.binaryType = 'arraybuffer';
         }
@@ -2056,7 +2044,6 @@ class JsonCodec {
 
 const defaults = {
     headers: {},
-    httpHeaders: {},
     token: '',
     getToken: null,
     data: null,
@@ -2076,6 +2063,7 @@ const defaults = {
     timeout: 5000,
     maxServerPingDelay: 10000,
     networkEventTarget: null,
+    wsProtocolToken: '',
 };
 class UnauthorizedError extends Error {
     constructor(message) {
@@ -2221,17 +2209,10 @@ class Centrifuge extends EventEmitter$1 {
     setHeaders(headers) {
         this._config.headers = headers;
     }
-    /** setHttpHeaders allows setting HTTP headers for WebSocket handshake.
-     * Only works in Node.js environment with 'ws' library.
-     * Browser WebSocket API does not support custom headers. */
-    setHttpHeaders(headers) {
-        this._config.httpHeaders = headers;
-    }
-    /** setWebsocket allows setting WebSocket implementation at runtime.
-     * Useful for lazy-loading 'ws' library in Node.js environment.
-     * Must be called before connect(). */
-    setWebsocket(websocket) {
-        this._config.websocket = websocket;
+    /** setWsProtocolToken allows setting token to pass via Sec-WebSocket-Protocol header.
+     * Works in both browser and Node.js environments. */
+    setWsProtocolToken(token) {
+        this._config.wsProtocolToken = token;
     }
     /** send asynchronous data to a server (without any response from a server
      * expected, see rpc method if you need response). */
@@ -2607,7 +2588,7 @@ class Centrifuge extends EventEmitter$1 {
                 this._debug('client will use websocket');
                 this._transport = new WebsocketTransport(this._endpoint, {
                     websocket: websocket,
-                    httpHeaders: this._config.httpHeaders
+                    wsProtocolToken: this._config.wsProtocolToken
                 });
                 if (!this._transport.supported()) {
                     throw new Error('WebSocket constructor not found, make sure it is available globally or passed as a dependency in Centrifuge options');
@@ -2631,7 +2612,7 @@ class Centrifuge extends EventEmitter$1 {
                     this._debug('trying websocket transport');
                     this._transport = new WebsocketTransport(transportEndpoint, {
                         websocket: websocket,
-                        httpHeaders: this._config.httpHeaders
+                        wsProtocolToken: this._config.wsProtocolToken
                     });
                     if (!this._transport.supported()) {
                         this._debug('websocket transport not available');

package/build/protobuf/types.d.ts

@@ -79,9 +79,7 @@ export interface Options {
     headers: {
         [key: string]: string;
     };
-    httpHeaders: {
-        [key: string]: string;
-    };
+    wsProtocolToken: string;
     /** allows enabling debug mode */
     debug: boolean;
     /** allows setting initial connection token (JWT) */

package/build/types.d.ts

@@ -79,9 +79,7 @@ export interface Options {
     headers: {
         [key: string]: string;
     };
-    httpHeaders: {
-        [key: string]: string;
-    };
+    wsProtocolToken: string;
     /** allows enabling debug mode */
     debug: boolean;
     /** allows setting initial connection token (JWT) */