Merge pull request #60 from chrisbygrave/ws-headers

Support for passing headers through to ws connect calls

Author: Chengxuan

lib/firefly.ts

@@ -1,5 +1,7 @@
 import { Stream, Readable } from 'stream';
+import * as http from 'http';
 import * as FormData from 'form-data';
+import * as WebSocket from 'ws';
 import {
   FireFlyStatusResponse,
   FireFlyPrivateSendOptions,
@@ -549,6 +551,7 @@ export default class FireFly extends HttpBase {
   listen(
     subscriptions: string | string[] | FireFlySubscriptionBase,
     callback: FireFlyWebSocketCallback,
+    socketOptions?: WebSocket.ClientOptions | http.ClientRequestArgs,
   ): FireFlyWebSocket {
     const options: FireFlyWebSocketOptions = {
       host: this.options.websocket.host,
@@ -559,6 +562,7 @@ export default class FireFly extends HttpBase {
       autoack: false,
       reconnectDelay: this.options.websocket.reconnectDelay,
       heartbeatInterval: this.options.websocket.heartbeatInterval,
+      socketOptions: socketOptions,
     };
 
     const handler: FireFlyWebSocketCallback = (socket, event) => {

lib/interfaces.ts

@@ -1,4 +1,6 @@
+import * as http from 'http';
 import { AxiosRequestConfig } from 'axios';
+import * as WebSocket from 'ws';
 import { operations } from './schema';
 
 /**
@@ -61,6 +63,7 @@ export interface FireFlyWebSocketOptions {
   autoack: boolean;
   reconnectDelay: number;
   heartbeatInterval: number;
+  socketOptions?: WebSocket.ClientOptions | http.ClientRequestArgs;
 }
 
 // Namespace

lib/websocket.ts

@@ -57,6 +57,7 @@ export class FireFlyWebSocket {
         ? `${this.options.username}:${this.options.password}`
         : undefined;
     const socket = (this.socket = new WebSocket(url, {
+      ...this.options.socketOptions,
       auth,
       handshakeTimeout: this.options.heartbeatInterval,
     }));

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperledger/firefly-sdk",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "Client SDK for Hyperledger FireFly",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",