shoonya-sdk 1.1.3 → 1.2.0

package/README.md

@@ -68,4 +68,5 @@ wsClient.connect();
 - Auto Refresh Access Token When it is expired
 - Sync Credentials and Tokens between Rest and WS Clients
 - Reconnect with Shoonya WS at fixed time interval, which is configurable
+- Configurable heartbeat timer to keep connection alive
 - and more...

package/dist/index.cjs

@@ -773,6 +773,8 @@ var WebsocketClient = class extends import_events.EventEmitter {
   logger;
   retryCount = 0;
   maxRetryAttempt;
+  isHeartbeatStarted = false;
+  heartbeatInterval;
   /**
    *
    * @param params
@@ -785,9 +787,11 @@ var WebsocketClient = class extends import_events.EventEmitter {
       cred,
       logging = false,
       logFileType = "SEPARATE",
-      maxRetryAttempt = 3
+      maxRetryAttempt = 3,
+      heartbeatInterval = 15e3
     } = params || {};
     this.maxRetryAttempt = maxRetryAttempt;
+    this.heartbeatInterval = heartbeatInterval;
     this.logger = new logger_default(
       "shoonya_ws-client",
       1024 * 1024 * 10,
@@ -840,6 +844,7 @@ var WebsocketClient = class extends import_events.EventEmitter {
     if (result.t === "ck" && result.s.toLowerCase() === "ok") {
       setTimeout(() => {
         this.logger.log("|WSClient| Connected with Shoonya WS.");
+        this.sendHeartbeat(this.heartbeatInterval);
         this.emit("connected");
         this.resubscribe();
       }, 3e3);
@@ -927,6 +932,9 @@ var WebsocketClient = class extends import_events.EventEmitter {
   close() {
     this.ws.close(0);
   }
+  isWsOpen() {
+    return this.ws.OPEN === this.ws.readyState;
+  }
   resubscribe() {
     if (this.subscribedTokens.length) {
       const tokensToSub = Array.from(new Set(this.subscribedTokens));
@@ -1009,9 +1017,6 @@ var WebsocketClient = class extends import_events.EventEmitter {
     }
     return null;
   }
-  isWsOpen() {
-    return this.ws.OPEN === this.ws.readyState;
-  }
   refreshAccessToken() {
     this.logger.log("Trying to refresh the Access Token");
     refreshAccessToken().then(() => {
@@ -1038,6 +1043,16 @@ var WebsocketClient = class extends import_events.EventEmitter {
     }
     return targetDate.getTime() - dateNow.getTime();
   }
+  sendHeartbeat(interval) {
+    if (this.isHeartbeatStarted)
+      return;
+    this.isHeartbeatStarted = true;
+    setInterval(() => {
+      if (this.isWsOpen()) {
+        this.ws.ping("ping");
+      }
+    }, interval);
+  }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.d.cts

@@ -914,6 +914,8 @@ declare class WebsocketClient extends EventEmitter {
     private logger;
     private retryCount;
     private maxRetryAttempt;
+    private isHeartbeatStarted;
+    private heartbeatInterval;
     /**
      *
      * @param params
@@ -926,6 +928,7 @@ declare class WebsocketClient extends EventEmitter {
         cred?: UserCred;
         logFileType?: LoggerType;
         maxRetryAttempt?: number;
+        heartbeatInterval?: number;
     });
     connect(): void;
     private wsOpenEvent;
@@ -935,15 +938,16 @@ declare class WebsocketClient extends EventEmitter {
     subscribe(scrips: string | string[], feedType?: FeedType): void;
     unsubscribe(scrips: string | string[]): void;
     close(): void;
+    isWsOpen(): boolean;
     private resubscribe;
     private send;
     private refreshEveryMorning;
     private parseDailyRefreshTime;
     private validateTimezoneString;
     private validateFeedType;
-    private isWsOpen;
     private refreshAccessToken;
     private calculateNextRefreshDelay;
+    private sendHeartbeat;
 }
 
 export { AddScripToWatchlist, BaseType, BaseTypeFail, BaseTypeSuccess, BaseTypeWithoutTime, BasketMargin, CancelOrder, ChangePassword, DailyTimeString, DepthSubscriptionUpdate, ExchMessage, Exchange, ExitSNOOrder, FeedType, ForgotPassword, GetClientDetails, GetHSToken, GetLimitsParam, GetListOfPredefinedMW, GetListOfPredefinedMWScrip, GetSecurityInfo, GetTokenExpiry, GetUserDetails, GetWatchlist, GetWatchlistNames, HistoricData, Holdings, IndexList, Limits, Login, LoginWithDevicePin, LogoutResponse, MakeKeysRequired, ModifyOrder, OptionChain, Order, OrderBook, OrderInput, OrderMargin, Path, PlaceOrder, PositionBook, ProductConversion, ProductType, RemoveScripFromWatchlist, RestClient, ScripInfo, SearchScrip, Segment, SetDevicePin, SingleOrderHistory, SingleOrderStatus, TopIndexList, TopIndexListNames, TradeBook, UserCred, ValidateHSToken, WebsocketClient, getQuotes, paths };

package/dist/index.d.ts

@@ -914,6 +914,8 @@ declare class WebsocketClient extends EventEmitter {
     private logger;
     private retryCount;
     private maxRetryAttempt;
+    private isHeartbeatStarted;
+    private heartbeatInterval;
     /**
      *
      * @param params
@@ -926,6 +928,7 @@ declare class WebsocketClient extends EventEmitter {
         cred?: UserCred;
         logFileType?: LoggerType;
         maxRetryAttempt?: number;
+        heartbeatInterval?: number;
     });
     connect(): void;
     private wsOpenEvent;
@@ -935,15 +938,16 @@ declare class WebsocketClient extends EventEmitter {
     subscribe(scrips: string | string[], feedType?: FeedType): void;
     unsubscribe(scrips: string | string[]): void;
     close(): void;
+    isWsOpen(): boolean;
     private resubscribe;
     private send;
     private refreshEveryMorning;
     private parseDailyRefreshTime;
     private validateTimezoneString;
     private validateFeedType;
-    private isWsOpen;
     private refreshAccessToken;
     private calculateNextRefreshDelay;
+    private sendHeartbeat;
 }
 
 export { AddScripToWatchlist, BaseType, BaseTypeFail, BaseTypeSuccess, BaseTypeWithoutTime, BasketMargin, CancelOrder, ChangePassword, DailyTimeString, DepthSubscriptionUpdate, ExchMessage, Exchange, ExitSNOOrder, FeedType, ForgotPassword, GetClientDetails, GetHSToken, GetLimitsParam, GetListOfPredefinedMW, GetListOfPredefinedMWScrip, GetSecurityInfo, GetTokenExpiry, GetUserDetails, GetWatchlist, GetWatchlistNames, HistoricData, Holdings, IndexList, Limits, Login, LoginWithDevicePin, LogoutResponse, MakeKeysRequired, ModifyOrder, OptionChain, Order, OrderBook, OrderInput, OrderMargin, Path, PlaceOrder, PositionBook, ProductConversion, ProductType, RemoveScripFromWatchlist, RestClient, ScripInfo, SearchScrip, Segment, SetDevicePin, SingleOrderHistory, SingleOrderStatus, TopIndexList, TopIndexListNames, TradeBook, UserCred, ValidateHSToken, WebsocketClient, getQuotes, paths };

package/dist/index.js

@@ -745,6 +745,8 @@ var WebsocketClient = class extends EventEmitter {
   logger;
   retryCount = 0;
   maxRetryAttempt;
+  isHeartbeatStarted = false;
+  heartbeatInterval;
   /**
    *
    * @param params
@@ -757,9 +759,11 @@ var WebsocketClient = class extends EventEmitter {
       cred,
       logging = false,
       logFileType = "SEPARATE",
-      maxRetryAttempt = 3
+      maxRetryAttempt = 3,
+      heartbeatInterval = 15e3
     } = params || {};
     this.maxRetryAttempt = maxRetryAttempt;
+    this.heartbeatInterval = heartbeatInterval;
     this.logger = new logger_default(
       "shoonya_ws-client",
       1024 * 1024 * 10,
@@ -812,6 +816,7 @@ var WebsocketClient = class extends EventEmitter {
     if (result.t === "ck" && result.s.toLowerCase() === "ok") {
       setTimeout(() => {
         this.logger.log("|WSClient| Connected with Shoonya WS.");
+        this.sendHeartbeat(this.heartbeatInterval);
         this.emit("connected");
         this.resubscribe();
       }, 3e3);
@@ -899,6 +904,9 @@ var WebsocketClient = class extends EventEmitter {
   close() {
     this.ws.close(0);
   }
+  isWsOpen() {
+    return this.ws.OPEN === this.ws.readyState;
+  }
   resubscribe() {
     if (this.subscribedTokens.length) {
       const tokensToSub = Array.from(new Set(this.subscribedTokens));
@@ -981,9 +989,6 @@ var WebsocketClient = class extends EventEmitter {
     }
     return null;
   }
-  isWsOpen() {
-    return this.ws.OPEN === this.ws.readyState;
-  }
   refreshAccessToken() {
     this.logger.log("Trying to refresh the Access Token");
     refreshAccessToken().then(() => {
@@ -1010,6 +1015,16 @@ var WebsocketClient = class extends EventEmitter {
     }
     return targetDate.getTime() - dateNow.getTime();
   }
+  sendHeartbeat(interval) {
+    if (this.isHeartbeatStarted)
+      return;
+    this.isHeartbeatStarted = true;
+    setInterval(() => {
+      if (this.isWsOpen()) {
+        this.ws.ping("ping");
+      }
+    }, interval);
+  }
 };
 export {
   RestClient,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shoonya-sdk",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "Wrapper around Shoonya API",
   "main": "dist/index.cjs",
   "module": "dist/index.js",