shoonya-sdk 0.3.6 → 0.4.0

package/dist/shoonya-sdk.d.mts

@@ -204,6 +204,11 @@ interface OrderBookFail {
 }
 type OrderBook = OrderBookSuccess[] | OrderBookFail;
 
+type ShoonyaWSEvents = "connect" | "open" | "priceUpdate" | "orderUpdate" | "stopped" | "close" | "reconnect" | "error";
+declare interface Shoonya {
+    on(eventName: ShoonyaWSEvents, listener: (...args: any[]) => void): this;
+    emit(eventName: ShoonyaWSEvents, ...args: any[]): boolean;
+}
 declare class Shoonya extends EventEmitter {
     accessToken: string;
     userId: string;
@@ -220,8 +225,21 @@ declare class Shoonya extends EventEmitter {
     private apiKey;
     private cronJobRunning;
     private scripList;
+    private reconnectTimeout;
+    private heartbeatTimeout;
+    private lastWsMsgAt;
     constructor(options?: {
         logging: boolean;
+        /**
+         * check for connection every x ms
+         * @default 30000
+         */
+        reconnectTimeout?: number;
+        /**
+         * send heartbeat msg in every x ms
+         * @default 3000
+         */
+        heartbeatTimeout?: number;
     });
     request<T>(path: Path, body: {
         data: RequestDataType;
@@ -319,6 +337,13 @@ declare class Shoonya extends EventEmitter {
     }>;
     private getFormattedExpiry;
     private getNextFormattedDates;
+    getLastWSMessage(): Date;
+    getWSState(): {
+        OPEN: boolean;
+        CLOSED: boolean;
+        CLOSING: boolean;
+        CONNECTING: boolean;
+    };
     connectWS(): void;
     /**
      *

package/dist/shoonya-sdk.d.ts

@@ -204,6 +204,11 @@ interface OrderBookFail {
 }
 type OrderBook = OrderBookSuccess[] | OrderBookFail;
 
+type ShoonyaWSEvents = "connect" | "open" | "priceUpdate" | "orderUpdate" | "stopped" | "close" | "reconnect" | "error";
+declare interface Shoonya {
+    on(eventName: ShoonyaWSEvents, listener: (...args: any[]) => void): this;
+    emit(eventName: ShoonyaWSEvents, ...args: any[]): boolean;
+}
 declare class Shoonya extends EventEmitter {
     accessToken: string;
     userId: string;
@@ -220,8 +225,21 @@ declare class Shoonya extends EventEmitter {
     private apiKey;
     private cronJobRunning;
     private scripList;
+    private reconnectTimeout;
+    private heartbeatTimeout;
+    private lastWsMsgAt;
     constructor(options?: {
         logging: boolean;
+        /**
+         * check for connection every x ms
+         * @default 30000
+         */
+        reconnectTimeout?: number;
+        /**
+         * send heartbeat msg in every x ms
+         * @default 3000
+         */
+        heartbeatTimeout?: number;
     });
     request<T>(path: Path, body: {
         data: RequestDataType;
@@ -319,6 +337,13 @@ declare class Shoonya extends EventEmitter {
     }>;
     private getFormattedExpiry;
     private getNextFormattedDates;
+    getLastWSMessage(): Date;
+    getWSState(): {
+        OPEN: boolean;
+        CLOSED: boolean;
+        CLOSING: boolean;
+        CONNECTING: boolean;
+    };
     connectWS(): void;
     /**
      *

package/dist/shoonya-sdk.js

@@ -158,13 +158,22 @@ var Shoonya = class extends import_events.EventEmitter {
   apiKey;
   cronJobRunning = false;
   scripList;
+  reconnectTimeout;
+  heartbeatTimeout;
+  lastWsMsgAt;
   constructor(options) {
-    const { logging = false } = options || {};
+    const {
+      logging = false,
+      reconnectTimeout = 3e4,
+      heartbeatTimeout = 3e3
+    } = options || {};
     super({ captureRejections: true });
     this.userId = "";
     this.accessToken = "";
     this.accountId = this.userId;
     this.logging = logging;
+    this.reconnectTimeout = { timer: null, timeout: reconnectTimeout };
+    this.heartbeatTimeout = { timer: null, timeout: heartbeatTimeout };
     if (logging) {
       this.logger = new logger_default(
         `./logs/log_${Date.now().toString()}.log`,
@@ -472,23 +481,34 @@ var Shoonya = class extends import_events.EventEmitter {
     return `${day}${newMonth}${newYear}`;
   }
   getNextFormattedDates(expiry) {
-    let multipler = 1;
+    let multiplier = 1;
     if (expiry === "next" || expiry === "more-than-1-day")
-      multipler = 2;
+      multiplier = 2;
     if (expiry === "next-next")
-      multipler = 3;
+      multiplier = 3;
     const dates = [];
     let currentDate = /* @__PURE__ */ new Date();
-    for (let i = 0; i <= 7 * multipler; i++) {
+    for (let i = 0; i <= 7 * multiplier; i++) {
       const formattedDate = this.getFormattedExpiry(currentDate);
       dates.push([formattedDate, currentDate]);
       currentDate = new Date(currentDate.setDate(currentDate.getDate() + 1));
     }
     return dates;
   }
+  getLastWSMessage() {
+    return this.lastWsMsgAt;
+  }
+  getWSState() {
+    return {
+      OPEN: this.ws && this.ws.readyState === this.ws.OPEN,
+      CLOSED: this.ws && this.ws.readyState === this.ws.CLOSED,
+      CLOSING: this.ws && this.ws.readyState === this.ws.CLOSING,
+      CONNECTING: this.ws && this.ws.readyState === this.ws.CONNECTING
+    };
+  }
   // WebSocket API
   connectWS() {
-    if (this.ws && (this.ws.readyState === 0 || this.ws.readyState === 1)) {
+    if (this.getWSState().OPEN || this.getWSState().CONNECTING) {
       return;
     }
     this.ws = new import_ws.WebSocket(this.wsBaseUrl);
@@ -501,15 +521,21 @@ var Shoonya = class extends import_events.EventEmitter {
         susertoken: this.accessToken
       };
       this.ws.send(JSON.stringify(msg));
+      this.emit("open", "opened ws connection");
+      clearInterval(this.heartbeatTimeout.timer);
+      this.heartbeatTimeout.timer = setInterval(() => {
+        const heartbeatMsg = '{"t":"h"}';
+        this.getWSState().OPEN && this.ws.send(heartbeatMsg);
+        this.logging && this.logger.log(`sent heartbeat message: ${heartbeatMsg}`);
+      }, this.heartbeatTimeout.timeout);
       if (this.cronJobRunning) {
         this.subscribe(this.scripList);
         return;
       }
-      import_node_cron.default.schedule("43,00 3,10 * * 1-5", async () => {
-        this.cronJobRunning = true;
-        const hour = (/* @__PURE__ */ new Date()).getUTCHours();
-        const min = (/* @__PURE__ */ new Date()).getUTCMinutes();
-        if (hour === 3 && min === 43) {
+      import_node_cron.default.schedule(
+        "13 9 * * 1-5",
+        async () => {
+          this.cronJobRunning = true;
           try {
             const cred = {
               apiKey: this.apiKey,
@@ -518,21 +544,21 @@ var Shoonya = class extends import_events.EventEmitter {
               userId: this.userId
             };
             await this.login(cred);
-            this.connectWS();
+            this.logging && this.logger.log("Token Refreshed");
           } catch (err) {
             console.error(err);
             const errMessage = `Token refreshing failed. ERR: ${err.message}`;
             this.logging && this.logger.log(errMessage, "ERROR");
+            this.getWSState().OPEN && this.ws.close();
             this.emit("stopped", errMessage);
           }
-        }
-        if (hour === 10 && min === 0) {
-          this.disconnect();
-        }
-      });
+        },
+        { timezone: "Asia/Kolkata" }
+      );
     });
     this.ws.addEventListener("message", (e) => {
       const result = JSON.parse(e.data.toString());
+      this.lastWsMsgAt = /* @__PURE__ */ new Date();
       if (result.t === "dk") {
         this.logging && this.logger.log(`Subscribed to ${result.ts}. Listening...`);
       }
@@ -550,6 +576,19 @@ var Shoonya = class extends import_events.EventEmitter {
         }, 3e3);
         return;
       }
+      clearTimeout(this.reconnectTimeout.timer);
+      this.reconnectTimeout.timer = setTimeout(() => {
+        let msg = {
+          t: "c",
+          uid: this.userId,
+          actid: this.accountId,
+          source: "API",
+          susertoken: this.accessToken
+        };
+        this.subscribe(this.scripList);
+        this.getWSState().OPEN && this.ws.send(JSON.stringify(msg));
+        this.emit("reconnect", "reconnected with shoonya ws");
+      }, this.reconnectTimeout.timeout);
       clearTimeout(this.disconnectTimer);
       this.disconnectTimer = setTimeout(() => {
         const day = (/* @__PURE__ */ new Date()).getDay();
@@ -558,7 +597,16 @@ var Shoonya = class extends import_events.EventEmitter {
         const err = "API have stopped to respond! there could be a problem with API or market has closed";
         this.logging && this.logger.log(err, "WARN");
         this.emit("stopped", err);
-      }, 6e4 * 60 * 18 - 15e3);
+        this.getWSState().OPEN && this.ws.close();
+      }, 6e4 * 60 * 18 - 1e4);
+    });
+    this.ws.addEventListener("error", (e) => {
+      this.logging && this.logger.log("some error in ws");
+      this.emit("error", e);
+      this.getWSState().OPEN && this.ws.close();
+    });
+    this.ws.addEventListener("close", (e) => {
+      this.emit("close", e);
     });
   }
   /**
@@ -609,7 +657,8 @@ var Shoonya = class extends import_events.EventEmitter {
     }
   }
   disconnect() {
-    if (this.ws && this.ws.readyState !== 2 && this.ws.readyState !== 3) {
+    if (this.getWSState().OPEN || this.getWSState().CONNECTING) {
+      clearInterval(this.heartbeatTimeout.timer);
       this.ws.close();
       this.logging && this.logger.log("Websocket Connection with Shoonya API is now closed!");
       this.emit("close");

package/dist/shoonya-sdk.mjs

@@ -132,13 +132,22 @@ var Shoonya = class extends EventEmitter {
   apiKey;
   cronJobRunning = false;
   scripList;
+  reconnectTimeout;
+  heartbeatTimeout;
+  lastWsMsgAt;
   constructor(options) {
-    const { logging = false } = options || {};
+    const {
+      logging = false,
+      reconnectTimeout = 3e4,
+      heartbeatTimeout = 3e3
+    } = options || {};
     super({ captureRejections: true });
     this.userId = "";
     this.accessToken = "";
     this.accountId = this.userId;
     this.logging = logging;
+    this.reconnectTimeout = { timer: null, timeout: reconnectTimeout };
+    this.heartbeatTimeout = { timer: null, timeout: heartbeatTimeout };
     if (logging) {
       this.logger = new logger_default(
         `./logs/log_${Date.now().toString()}.log`,
@@ -446,23 +455,34 @@ var Shoonya = class extends EventEmitter {
     return `${day}${newMonth}${newYear}`;
   }
   getNextFormattedDates(expiry) {
-    let multipler = 1;
+    let multiplier = 1;
     if (expiry === "next" || expiry === "more-than-1-day")
-      multipler = 2;
+      multiplier = 2;
     if (expiry === "next-next")
-      multipler = 3;
+      multiplier = 3;
     const dates = [];
     let currentDate = /* @__PURE__ */ new Date();
-    for (let i = 0; i <= 7 * multipler; i++) {
+    for (let i = 0; i <= 7 * multiplier; i++) {
       const formattedDate = this.getFormattedExpiry(currentDate);
       dates.push([formattedDate, currentDate]);
       currentDate = new Date(currentDate.setDate(currentDate.getDate() + 1));
     }
     return dates;
   }
+  getLastWSMessage() {
+    return this.lastWsMsgAt;
+  }
+  getWSState() {
+    return {
+      OPEN: this.ws && this.ws.readyState === this.ws.OPEN,
+      CLOSED: this.ws && this.ws.readyState === this.ws.CLOSED,
+      CLOSING: this.ws && this.ws.readyState === this.ws.CLOSING,
+      CONNECTING: this.ws && this.ws.readyState === this.ws.CONNECTING
+    };
+  }
   // WebSocket API
   connectWS() {
-    if (this.ws && (this.ws.readyState === 0 || this.ws.readyState === 1)) {
+    if (this.getWSState().OPEN || this.getWSState().CONNECTING) {
       return;
     }
     this.ws = new WS(this.wsBaseUrl);
@@ -475,15 +495,21 @@ var Shoonya = class extends EventEmitter {
         susertoken: this.accessToken
       };
       this.ws.send(JSON.stringify(msg));
+      this.emit("open", "opened ws connection");
+      clearInterval(this.heartbeatTimeout.timer);
+      this.heartbeatTimeout.timer = setInterval(() => {
+        const heartbeatMsg = '{"t":"h"}';
+        this.getWSState().OPEN && this.ws.send(heartbeatMsg);
+        this.logging && this.logger.log(`sent heartbeat message: ${heartbeatMsg}`);
+      }, this.heartbeatTimeout.timeout);
       if (this.cronJobRunning) {
         this.subscribe(this.scripList);
         return;
       }
-      cron.schedule("43,00 3,10 * * 1-5", async () => {
-        this.cronJobRunning = true;
-        const hour = (/* @__PURE__ */ new Date()).getUTCHours();
-        const min = (/* @__PURE__ */ new Date()).getUTCMinutes();
-        if (hour === 3 && min === 43) {
+      cron.schedule(
+        "13 9 * * 1-5",
+        async () => {
+          this.cronJobRunning = true;
           try {
             const cred = {
               apiKey: this.apiKey,
@@ -492,21 +518,21 @@ var Shoonya = class extends EventEmitter {
               userId: this.userId
             };
             await this.login(cred);
-            this.connectWS();
+            this.logging && this.logger.log("Token Refreshed");
           } catch (err) {
             console.error(err);
             const errMessage = `Token refreshing failed. ERR: ${err.message}`;
             this.logging && this.logger.log(errMessage, "ERROR");
+            this.getWSState().OPEN && this.ws.close();
             this.emit("stopped", errMessage);
           }
-        }
-        if (hour === 10 && min === 0) {
-          this.disconnect();
-        }
-      });
+        },
+        { timezone: "Asia/Kolkata" }
+      );
     });
     this.ws.addEventListener("message", (e) => {
       const result = JSON.parse(e.data.toString());
+      this.lastWsMsgAt = /* @__PURE__ */ new Date();
       if (result.t === "dk") {
         this.logging && this.logger.log(`Subscribed to ${result.ts}. Listening...`);
       }
@@ -524,6 +550,19 @@ var Shoonya = class extends EventEmitter {
         }, 3e3);
         return;
       }
+      clearTimeout(this.reconnectTimeout.timer);
+      this.reconnectTimeout.timer = setTimeout(() => {
+        let msg = {
+          t: "c",
+          uid: this.userId,
+          actid: this.accountId,
+          source: "API",
+          susertoken: this.accessToken
+        };
+        this.subscribe(this.scripList);
+        this.getWSState().OPEN && this.ws.send(JSON.stringify(msg));
+        this.emit("reconnect", "reconnected with shoonya ws");
+      }, this.reconnectTimeout.timeout);
       clearTimeout(this.disconnectTimer);
       this.disconnectTimer = setTimeout(() => {
         const day = (/* @__PURE__ */ new Date()).getDay();
@@ -532,7 +571,16 @@ var Shoonya = class extends EventEmitter {
         const err = "API have stopped to respond! there could be a problem with API or market has closed";
         this.logging && this.logger.log(err, "WARN");
         this.emit("stopped", err);
-      }, 6e4 * 60 * 18 - 15e3);
+        this.getWSState().OPEN && this.ws.close();
+      }, 6e4 * 60 * 18 - 1e4);
+    });
+    this.ws.addEventListener("error", (e) => {
+      this.logging && this.logger.log("some error in ws");
+      this.emit("error", e);
+      this.getWSState().OPEN && this.ws.close();
+    });
+    this.ws.addEventListener("close", (e) => {
+      this.emit("close", e);
     });
   }
   /**
@@ -583,7 +631,8 @@ var Shoonya = class extends EventEmitter {
     }
   }
   disconnect() {
-    if (this.ws && this.ws.readyState !== 2 && this.ws.readyState !== 3) {
+    if (this.getWSState().OPEN || this.getWSState().CONNECTING) {
+      clearInterval(this.heartbeatTimeout.timer);
       this.ws.close();
       this.logging && this.logger.log("Websocket Connection with Shoonya API is now closed!");
       this.emit("close");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shoonya-sdk",
-  "version": "0.3.6",
+  "version": "0.4.0",
   "description": "Wrapper around Shoonya API",
   "main": "dist/shoonya-sdk.js",
   "module": "dist/shoonya-sdk.mjs",