shoonya-sdk 1.1.2 → 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

@@ -77,27 +77,6 @@ var import_totp_generator2 = __toESM(require("totp-generator"), 1);
 
 // src/token-manager.ts
 var import_totp_generator = __toESM(require("totp-generator"), 1);
-
-// src/utils/request.ts
-async function request(path, body) {
-  const httpBaseUrl = "https://api.shoonya.com/NorenWClientTP/";
-  const jData = `jData=${JSON.stringify(body.data)}${body.key ? "&jKey=" + body.key : ""}`;
-  try {
-    const req = await fetch(httpBaseUrl + paths[path], {
-      method: "POST",
-      body: jData,
-      keepalive: false
-    });
-    let data = await req.json();
-    return data;
-  } catch (err) {
-    const errMessage = `Error: ${err?.message} in ${path}`;
-    throw new Error(errMessage);
-  }
-}
-__name(request, "request");
-
-// src/token-manager.ts
 var Tokens = class {
   static {
     __name(this, "Tokens");
@@ -142,6 +121,25 @@ var Tokens = class {
 };
 var tokens = new Tokens();
 async function refreshAccessToken(retryCount = 3) {
+  let errorMsg = "";
+  for (let i = 0; i < retryCount; i++) {
+    try {
+      logWithDate("trying to fetch the access token");
+      const token = await getAccessToken();
+      logWithDate("fetched token successfully");
+      tokens.updateAccessToken(token);
+      logWithDate("updated token successfully");
+      return;
+    } catch (errMsg) {
+      errorMsg += `${errMsg}, `;
+    }
+  }
+  throw new Error(
+    `Attempted to refresh access token ${retryCount} times. but failed. Errors: ${errorMsg}`
+  );
+}
+__name(refreshAccessToken, "refreshAccessToken");
+function getAccessToken() {
   const userCred = tokens.getCred();
   const cred = {
     apkversion: "1.0.0",
@@ -153,25 +151,33 @@ async function refreshAccessToken(retryCount = 3) {
     imei: userCred?.imei || "api",
     source: "API"
   };
-  let errorMsg = "";
-  for (let i = 0; i < retryCount; i++) {
-    try {
-      const req = await request("login", { data: cred });
-      tokens.updateAccessToken(req.susertoken);
-      return;
-    } catch (err) {
-      let errMsg = "Couldn't Refresh the Access Token. ";
-      if (err instanceof Error) {
-        errMsg += `Error: ${err.message}`;
+  return new Promise((resolve2, reject) => {
+    const jData = `jData=${JSON.stringify(cred)}`;
+    fetch("https://api.shoonya.com/NorenWClientTP/QuickAuth", {
+      method: "POST",
+      body: jData
+    }).then((res) => res.json()).then((data) => {
+      if (data.stat.toLowerCase() === "ok") {
+        logWithDate("refreshed token successfully");
+        return resolve2(data.susertoken);
       }
-      errorMsg += `${errMsg}, `;
-    }
-  }
-  throw new Error(
-    `Attempted to refresh access token ${retryCount} times. but failed. Errors: ${errorMsg}`
-  );
+      logWithDate("failed to refresh token due to", data.emsg);
+      reject(data.emsg);
+    }).catch((err) => {
+      errorLogWithDate("Failed to refresh token. Error", err);
+      reject(err.message);
+    });
+  });
 }
-__name(refreshAccessToken, "refreshAccessToken");
+__name(getAccessToken, "getAccessToken");
+function logWithDate(...data) {
+  console.log("[", (/* @__PURE__ */ new Date()).toISOString(), "]:", ...data);
+}
+__name(logWithDate, "logWithDate");
+function errorLogWithDate(...data) {
+  console.error("[", (/* @__PURE__ */ new Date()).toISOString(), "]:", ...data);
+}
+__name(errorLogWithDate, "errorLogWithDate");
 
 // src/utils/logger.ts
 var import_node_path = require("path");
@@ -767,6 +773,8 @@ var WebsocketClient = class extends import_events.EventEmitter {
   logger;
   retryCount = 0;
   maxRetryAttempt;
+  isHeartbeatStarted = false;
+  heartbeatInterval;
   /**
    *
    * @param params
@@ -779,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,
@@ -834,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);
@@ -863,7 +874,7 @@ var WebsocketClient = class extends import_events.EventEmitter {
     this.emit("error", error);
     this.ws.close(0);
   };
-  wsCloseEvent = async (code, reason) => {
+  wsCloseEvent = (code, reason) => {
     this.logger.log(
       `WS Close Event: code: ${code}, reason: ${reason.toString()}`
     );
@@ -872,19 +883,7 @@ var WebsocketClient = class extends import_events.EventEmitter {
       return;
     }
     if (code === 1) {
-      try {
-        this.logger.log("Trying to refresh the Access Token");
-        await refreshAccessToken();
-        this.logger.log("Access Token Refreshed");
-      } catch (err) {
-        err instanceof Error && this.logger.log(
-          `Failed to update access token. Err: ${err.message}`,
-          "ERROR"
-        );
-        console.error("Failed to refresh access token", err);
-      }
-      this.emit("tokenRefresh");
-      this.connect();
+      this.refreshAccessToken();
       return;
     }
     if (this.retryCount === this.maxRetryAttempt) {
@@ -933,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));
@@ -953,21 +955,24 @@ var WebsocketClient = class extends import_events.EventEmitter {
   }
   refreshEveryMorning = (dt) => {
     const { hour, min } = dt;
-    let lastMin = -1;
-    this.logger.log("Initialized Infinite Loop");
-    setInterval(() => {
-      const date = /* @__PURE__ */ new Date();
-      const currentMin = date.getUTCMinutes();
-      const currentHour = date.getUTCHours();
-      if (lastMin !== min && hour === currentHour && min === currentMin) {
-        this.logger.log(
-          `refreshing access token at ${currentHour}:${currentMin} - ${lastMin}`
-        );
-        lastMin = min;
-        return this.ws.close(1, "Reconnection");
+    const task = /* @__PURE__ */ __name(() => {
+      this.logger.log(`time to refresh access token`);
+      if (this.isWsOpen()) {
+        this.ws.close(1, "Reconnection");
+      } else {
+        this.refreshAccessToken();
       }
-      lastMin = -1;
-    }, 5e4);
+      const delay2 = this.calculateNextRefreshDelay(hour, min);
+      this.logger.log(
+        `Token will refresh at ${new Date(Date.now() + delay2).toISOString()}`
+      );
+      setTimeout(task, delay2);
+    }, "task");
+    const delay = this.calculateNextRefreshDelay(hour, min);
+    this.logger.log(
+      `Token will refresh at ${new Date(Date.now() + delay).toISOString()}`
+    );
+    setTimeout(task, delay);
   };
   parseDailyRefreshTime(time) {
     const [offsetType] = time[5];
@@ -1012,6 +1017,42 @@ var WebsocketClient = class extends import_events.EventEmitter {
     }
     return null;
   }
+  refreshAccessToken() {
+    this.logger.log("Trying to refresh the Access Token");
+    refreshAccessToken().then(() => {
+      this.logger.log("Access Token Refreshed");
+      this.emit("tokenRefresh");
+      this.connect();
+    }).catch((err) => {
+      this.logger.log(
+        `Failed to update access token. Err: ${err.message}`,
+        "ERROR"
+      );
+      console.error("Failed to refresh access token", err);
+    });
+  }
+  calculateNextRefreshDelay(hour, minute) {
+    const dateNow = /* @__PURE__ */ new Date();
+    const targetDate = new Date(dateNow);
+    targetDate.setUTCHours(hour, minute, 0, 0);
+    if (targetDate <= dateNow) {
+      targetDate.setUTCDate(targetDate.getUTCDate() + 1);
+    }
+    while ([0, 6].includes(targetDate.getUTCDay())) {
+      targetDate.setUTCDate(targetDate.getUTCDate() + 1);
+    }
+    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

@@ -813,7 +813,13 @@ declare class RestClient {
     getHistoricData(option: {
         exch: string;
         token: string;
+        /**
+         * time in seconds since 1st Jan 1970
+         */
         st?: string;
+        /**
+         * time in seconds since 1st Jan 1970
+         */
         et?: string;
     }): Promise<HistoricData>;
     getOptionChain(option: {
@@ -908,6 +914,8 @@ declare class WebsocketClient extends EventEmitter {
     private logger;
     private retryCount;
     private maxRetryAttempt;
+    private isHeartbeatStarted;
+    private heartbeatInterval;
     /**
      *
      * @param params
@@ -920,6 +928,7 @@ declare class WebsocketClient extends EventEmitter {
         cred?: UserCred;
         logFileType?: LoggerType;
         maxRetryAttempt?: number;
+        heartbeatInterval?: number;
     });
     connect(): void;
     private wsOpenEvent;
@@ -929,12 +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 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

@@ -813,7 +813,13 @@ declare class RestClient {
     getHistoricData(option: {
         exch: string;
         token: string;
+        /**
+         * time in seconds since 1st Jan 1970
+         */
         st?: string;
+        /**
+         * time in seconds since 1st Jan 1970
+         */
         et?: string;
     }): Promise<HistoricData>;
     getOptionChain(option: {
@@ -908,6 +914,8 @@ declare class WebsocketClient extends EventEmitter {
     private logger;
     private retryCount;
     private maxRetryAttempt;
+    private isHeartbeatStarted;
+    private heartbeatInterval;
     /**
      *
      * @param params
@@ -920,6 +928,7 @@ declare class WebsocketClient extends EventEmitter {
         cred?: UserCred;
         logFileType?: LoggerType;
         maxRetryAttempt?: number;
+        heartbeatInterval?: number;
     });
     connect(): void;
     private wsOpenEvent;
@@ -929,12 +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 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

@@ -42,27 +42,6 @@ import totp2 from "totp-generator";
 
 // src/token-manager.ts
 import totp from "totp-generator";
-
-// src/utils/request.ts
-async function request(path, body) {
-  const httpBaseUrl = "https://api.shoonya.com/NorenWClientTP/";
-  const jData = `jData=${JSON.stringify(body.data)}${body.key ? "&jKey=" + body.key : ""}`;
-  try {
-    const req = await fetch(httpBaseUrl + paths[path], {
-      method: "POST",
-      body: jData,
-      keepalive: false
-    });
-    let data = await req.json();
-    return data;
-  } catch (err) {
-    const errMessage = `Error: ${err?.message} in ${path}`;
-    throw new Error(errMessage);
-  }
-}
-__name(request, "request");
-
-// src/token-manager.ts
 var Tokens = class {
   static {
     __name(this, "Tokens");
@@ -107,6 +86,25 @@ var Tokens = class {
 };
 var tokens = new Tokens();
 async function refreshAccessToken(retryCount = 3) {
+  let errorMsg = "";
+  for (let i = 0; i < retryCount; i++) {
+    try {
+      logWithDate("trying to fetch the access token");
+      const token = await getAccessToken();
+      logWithDate("fetched token successfully");
+      tokens.updateAccessToken(token);
+      logWithDate("updated token successfully");
+      return;
+    } catch (errMsg) {
+      errorMsg += `${errMsg}, `;
+    }
+  }
+  throw new Error(
+    `Attempted to refresh access token ${retryCount} times. but failed. Errors: ${errorMsg}`
+  );
+}
+__name(refreshAccessToken, "refreshAccessToken");
+function getAccessToken() {
   const userCred = tokens.getCred();
   const cred = {
     apkversion: "1.0.0",
@@ -118,25 +116,33 @@ async function refreshAccessToken(retryCount = 3) {
     imei: userCred?.imei || "api",
     source: "API"
   };
-  let errorMsg = "";
-  for (let i = 0; i < retryCount; i++) {
-    try {
-      const req = await request("login", { data: cred });
-      tokens.updateAccessToken(req.susertoken);
-      return;
-    } catch (err) {
-      let errMsg = "Couldn't Refresh the Access Token. ";
-      if (err instanceof Error) {
-        errMsg += `Error: ${err.message}`;
+  return new Promise((resolve2, reject) => {
+    const jData = `jData=${JSON.stringify(cred)}`;
+    fetch("https://api.shoonya.com/NorenWClientTP/QuickAuth", {
+      method: "POST",
+      body: jData
+    }).then((res) => res.json()).then((data) => {
+      if (data.stat.toLowerCase() === "ok") {
+        logWithDate("refreshed token successfully");
+        return resolve2(data.susertoken);
       }
-      errorMsg += `${errMsg}, `;
-    }
-  }
-  throw new Error(
-    `Attempted to refresh access token ${retryCount} times. but failed. Errors: ${errorMsg}`
-  );
+      logWithDate("failed to refresh token due to", data.emsg);
+      reject(data.emsg);
+    }).catch((err) => {
+      errorLogWithDate("Failed to refresh token. Error", err);
+      reject(err.message);
+    });
+  });
 }
-__name(refreshAccessToken, "refreshAccessToken");
+__name(getAccessToken, "getAccessToken");
+function logWithDate(...data) {
+  console.log("[", (/* @__PURE__ */ new Date()).toISOString(), "]:", ...data);
+}
+__name(logWithDate, "logWithDate");
+function errorLogWithDate(...data) {
+  console.error("[", (/* @__PURE__ */ new Date()).toISOString(), "]:", ...data);
+}
+__name(errorLogWithDate, "errorLogWithDate");
 
 // src/utils/logger.ts
 import { resolve, dirname } from "node:path";
@@ -739,6 +745,8 @@ var WebsocketClient = class extends EventEmitter {
   logger;
   retryCount = 0;
   maxRetryAttempt;
+  isHeartbeatStarted = false;
+  heartbeatInterval;
   /**
    *
    * @param params
@@ -751,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,
@@ -806,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);
@@ -835,7 +846,7 @@ var WebsocketClient = class extends EventEmitter {
     this.emit("error", error);
     this.ws.close(0);
   };
-  wsCloseEvent = async (code, reason) => {
+  wsCloseEvent = (code, reason) => {
     this.logger.log(
       `WS Close Event: code: ${code}, reason: ${reason.toString()}`
     );
@@ -844,19 +855,7 @@ var WebsocketClient = class extends EventEmitter {
       return;
     }
     if (code === 1) {
-      try {
-        this.logger.log("Trying to refresh the Access Token");
-        await refreshAccessToken();
-        this.logger.log("Access Token Refreshed");
-      } catch (err) {
-        err instanceof Error && this.logger.log(
-          `Failed to update access token. Err: ${err.message}`,
-          "ERROR"
-        );
-        console.error("Failed to refresh access token", err);
-      }
-      this.emit("tokenRefresh");
-      this.connect();
+      this.refreshAccessToken();
       return;
     }
     if (this.retryCount === this.maxRetryAttempt) {
@@ -905,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));
@@ -925,21 +927,24 @@ var WebsocketClient = class extends EventEmitter {
   }
   refreshEveryMorning = (dt) => {
     const { hour, min } = dt;
-    let lastMin = -1;
-    this.logger.log("Initialized Infinite Loop");
-    setInterval(() => {
-      const date = /* @__PURE__ */ new Date();
-      const currentMin = date.getUTCMinutes();
-      const currentHour = date.getUTCHours();
-      if (lastMin !== min && hour === currentHour && min === currentMin) {
-        this.logger.log(
-          `refreshing access token at ${currentHour}:${currentMin} - ${lastMin}`
-        );
-        lastMin = min;
-        return this.ws.close(1, "Reconnection");
+    const task = /* @__PURE__ */ __name(() => {
+      this.logger.log(`time to refresh access token`);
+      if (this.isWsOpen()) {
+        this.ws.close(1, "Reconnection");
+      } else {
+        this.refreshAccessToken();
       }
-      lastMin = -1;
-    }, 5e4);
+      const delay2 = this.calculateNextRefreshDelay(hour, min);
+      this.logger.log(
+        `Token will refresh at ${new Date(Date.now() + delay2).toISOString()}`
+      );
+      setTimeout(task, delay2);
+    }, "task");
+    const delay = this.calculateNextRefreshDelay(hour, min);
+    this.logger.log(
+      `Token will refresh at ${new Date(Date.now() + delay).toISOString()}`
+    );
+    setTimeout(task, delay);
   };
   parseDailyRefreshTime(time) {
     const [offsetType] = time[5];
@@ -984,6 +989,42 @@ var WebsocketClient = class extends EventEmitter {
     }
     return null;
   }
+  refreshAccessToken() {
+    this.logger.log("Trying to refresh the Access Token");
+    refreshAccessToken().then(() => {
+      this.logger.log("Access Token Refreshed");
+      this.emit("tokenRefresh");
+      this.connect();
+    }).catch((err) => {
+      this.logger.log(
+        `Failed to update access token. Err: ${err.message}`,
+        "ERROR"
+      );
+      console.error("Failed to refresh access token", err);
+    });
+  }
+  calculateNextRefreshDelay(hour, minute) {
+    const dateNow = /* @__PURE__ */ new Date();
+    const targetDate = new Date(dateNow);
+    targetDate.setUTCHours(hour, minute, 0, 0);
+    if (targetDate <= dateNow) {
+      targetDate.setUTCDate(targetDate.getUTCDate() + 1);
+    }
+    while ([0, 6].includes(targetDate.getUTCDay())) {
+      targetDate.setUTCDate(targetDate.getUTCDate() + 1);
+    }
+    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.2",
+  "version": "1.2.0",
   "description": "Wrapper around Shoonya API",
   "main": "dist/index.cjs",
   "module": "dist/index.js",