shoonya-sdk 1.0.0 → 1.1.0

package/README.md

@@ -25,7 +25,7 @@ import { RestClient, WebsocketClient } from "shoonya-sdk";
 const restClient = new RestClient(credentials, { logging: true });
 const wsClient = new WebsocketClient({ logging: true }); // No need to pass credential here
 
-const userDetail = restClient.getUserDetails();
+const userDetail = await restClient.getUserDetails();
 console.log(`Logged in as ${userDetail.actid}`);
 
 wsClient.on("connected", () => {

package/dist/index.cjs

@@ -175,48 +175,50 @@ var Logger = class {
   maxSize = 0;
   fileName = "";
   logging;
+  type;
   /**
    *
    * @param logFileName name to prepend the logs file with
    * @param size max size of file (in bytes)
    */
-  constructor(logFileName, size) {
+  constructor(logFileName, size, type = "UNIFIED") {
     this.logPath = (0, import_node_path.resolve)("./logs", `${logFileName}_${Date.now()}.log`);
     this.maxSize = size;
     this.fileName = logFileName;
+    this.type = type;
   }
   log(msg, logType = "DEBUG") {
     if (!this.logging)
       return;
-    this.checkPathExistance();
+    const path = this.checkPathExistance(logType);
     const content = `${logType}:[${(/* @__PURE__ */ new Date()).toISOString()}]:${msg}
 `;
     try {
-      (0, import_node_fs.appendFileSync)(this.logPath, content);
+      (0, import_node_fs.appendFileSync)(path, content);
     } catch (err) {
       console.error(`Failed to write to log file: ${err}`);
     }
     try {
       (0, import_node_fs.existsSync)(this.logPath);
-      this.checkLogSize();
+      this.checkLogSize(path);
     } catch {
       console.log("Log file not exists");
     }
   }
-  checkLogSize() {
-    const dirName = (0, import_node_path.dirname)(this.logPath);
+  checkLogSize(path) {
+    const dirName = (0, import_node_path.dirname)(path);
     try {
-      const stats = (0, import_node_fs.statSync)(this.logPath);
+      const stats = (0, import_node_fs.statSync)(path);
       if (stats.size >= this.maxSize) {
         this.logPath = (0, import_node_path.resolve)(dirName, `${this.fileName}_${Date.now()}.log`);
-        this.deleteOldestFile();
+        this.deleteOldestFile(path);
       }
     } catch (err) {
       console.log("File not found");
     }
   }
-  deleteOldestFile() {
-    const dirName = (0, import_node_path.dirname)(this.logPath);
+  deleteOldestFile(path) {
+    const dirName = (0, import_node_path.dirname)(path);
     const files = (0, import_node_fs.readdirSync)(dirName);
     const currentDate = /* @__PURE__ */ new Date();
     const sevenDaysAgo = (/* @__PURE__ */ new Date()).setDate(currentDate.getDate() - 7);
@@ -228,11 +230,13 @@ var Logger = class {
       }
     }
   }
-  async checkPathExistance() {
-    const pathExists = (0, import_node_fs.existsSync)(this.logPath);
+  checkPathExistance(type) {
+    const path = this.type === "SEPARATE" ? `${this.logPath.split(".")[0]}_${type.toLowerCase()}.log` : this.logPath;
+    const pathExists = (0, import_node_fs.existsSync)(path);
     if (!pathExists) {
       (0, import_node_fs.mkdirSync)((0, import_node_path.dirname)(this.logPath), { recursive: true });
     }
+    return path;
   }
 };
 var logger_default = Logger;
@@ -754,6 +758,7 @@ var WebsocketClient = class extends import_events.EventEmitter {
   reconnectTimer;
   subscribedTokens = [];
   logger;
+  maxRetryAttempt;
   /**
    *
    * @param params
@@ -762,12 +767,19 @@ var WebsocketClient = class extends import_events.EventEmitter {
   constructor(params) {
     super();
     const {
-      reconnectInterval = 3e3,
+      reconnectInterval = 3e4,
       dailyRefreshTime = "09:10+05:30",
       cred,
-      logging = false
+      logging = false,
+      logFileType = "SEPARATE",
+      maxRetryAttepmt = 3
     } = params || {};
-    this.logger = new logger_default("shoonya_ws-client", 1024 * 1024);
+    this.maxRetryAttempt = maxRetryAttepmt;
+    this.logger = new logger_default(
+      "shoonya_ws-client",
+      1024 * 1024 * 10,
+      logFileType
+    );
     this.logger.logging ||= logging;
     const storedCred = tokens.getCred();
     const c = storedCred.userId ? storedCred : cred;
@@ -813,7 +825,7 @@ var WebsocketClient = class extends import_events.EventEmitter {
   };
   wsMessageEvent = (msg) => {
     const result = JSON.parse(msg.toString());
-    if (result.t === "ck") {
+    if (result.t === "ck" && result.s.toLowerCase() === "ok") {
       console.log("Connected with Shoonya Websocket.");
       this.logger.log("|WSClient| Connected with Shoonya WS.");
       clearInterval(this.reconnectTimer);
@@ -848,6 +860,7 @@ var WebsocketClient = class extends import_events.EventEmitter {
     if (code === 1) {
       try {
         await refreshAccessToken();
+        this.logger.log("Access Token Refreshed");
       } catch (err) {
         err instanceof Error && this.logger.log(err.message, "ERROR");
       }
@@ -856,10 +869,18 @@ var WebsocketClient = class extends import_events.EventEmitter {
       return;
     }
     if (code !== 0) {
-      this.logger.log("Disconnected. Attempting to reconnect....");
+      let retryAttempts = 0;
       clearInterval(this.reconnectTimer);
       this.reconnectTimer = setInterval(() => {
+        retryAttempts++;
+        this.logger.log(
+          `Disconnected with error code ${code}. Attempt ${retryAttempts} to reconnect....`
+        );
         this.connect();
+        if (this.maxRetryAttempt === retryAttempts) {
+          this.logger.log("Max Retry Attempt Reached. Stopped Retrying.");
+          clearInterval(this.reconnectInterval);
+        }
       }, this.reconnectInterval);
       return;
     }
@@ -888,6 +909,9 @@ var WebsocketClient = class extends import_events.EventEmitter {
       // unsubcribe depth subscription
       k: scripList.join("#")
     };
+    this.subscribedTokens = this.subscribedTokens.filter(
+      (item) => !scripList.includes(item)
+    );
     this.send(msg);
   }
   resubscribe() {
@@ -910,6 +934,7 @@ var WebsocketClient = class extends import_events.EventEmitter {
       const currentMin = date.getUTCMinutes();
       const currentHour = date.getUTCHours();
       if (lastMin !== min && hour === currentHour && min === currentMin) {
+        this.logger.log("refreshing access token");
         this.ws.close(1);
         lastMin = min;
         return;

package/dist/index.d.cts

@@ -879,6 +879,8 @@ declare class RestClient {
     };
 }
 
+type LoggerType = "UNIFIED" | "SEPARATE";
+
 type DailyTimeString = `${number}:${number}${"+" | "-"}${number}:${number}`;
 interface Events {
     open: () => void;
@@ -905,6 +907,7 @@ declare class WebsocketClient extends EventEmitter {
     private reconnectTimer;
     private subscribedTokens;
     private logger;
+    private maxRetryAttempt;
     /**
      *
      * @param params
@@ -915,6 +918,8 @@ declare class WebsocketClient extends EventEmitter {
         dailyRefreshTime?: DailyTimeString;
         logging?: boolean;
         cred?: UserCred;
+        logFileType?: LoggerType;
+        maxRetryAttepmt: number;
     });
     connect(): void;
     private wsOpenEvent;
@@ -930,4 +935,4 @@ declare class WebsocketClient extends EventEmitter {
     private validateTimezoneString;
 }
 
-export { AddScripToWatchlist, BaseType, BaseTypeFail, BaseTypeSuccess, BaseTypeWithoutTime, BasketMargin, CancelOrder, ChangePassword, DepthSubscriptionUpdate, ExchMessage, Exchange, ExitSNOOrder, 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 };
+export { AddScripToWatchlist, BaseType, BaseTypeFail, BaseTypeSuccess, BaseTypeWithoutTime, BasketMargin, CancelOrder, ChangePassword, DailyTimeString, DepthSubscriptionUpdate, ExchMessage, Exchange, ExitSNOOrder, 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

@@ -879,6 +879,8 @@ declare class RestClient {
     };
 }
 
+type LoggerType = "UNIFIED" | "SEPARATE";
+
 type DailyTimeString = `${number}:${number}${"+" | "-"}${number}:${number}`;
 interface Events {
     open: () => void;
@@ -905,6 +907,7 @@ declare class WebsocketClient extends EventEmitter {
     private reconnectTimer;
     private subscribedTokens;
     private logger;
+    private maxRetryAttempt;
     /**
      *
      * @param params
@@ -915,6 +918,8 @@ declare class WebsocketClient extends EventEmitter {
         dailyRefreshTime?: DailyTimeString;
         logging?: boolean;
         cred?: UserCred;
+        logFileType?: LoggerType;
+        maxRetryAttepmt: number;
     });
     connect(): void;
     private wsOpenEvent;
@@ -930,4 +935,4 @@ declare class WebsocketClient extends EventEmitter {
     private validateTimezoneString;
 }
 
-export { AddScripToWatchlist, BaseType, BaseTypeFail, BaseTypeSuccess, BaseTypeWithoutTime, BasketMargin, CancelOrder, ChangePassword, DepthSubscriptionUpdate, ExchMessage, Exchange, ExitSNOOrder, 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 };
+export { AddScripToWatchlist, BaseType, BaseTypeFail, BaseTypeSuccess, BaseTypeWithoutTime, BasketMargin, CancelOrder, ChangePassword, DailyTimeString, DepthSubscriptionUpdate, ExchMessage, Exchange, ExitSNOOrder, 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

@@ -147,48 +147,50 @@ var Logger = class {
   maxSize = 0;
   fileName = "";
   logging;
+  type;
   /**
    *
    * @param logFileName name to prepend the logs file with
    * @param size max size of file (in bytes)
    */
-  constructor(logFileName, size) {
+  constructor(logFileName, size, type = "UNIFIED") {
     this.logPath = resolve("./logs", `${logFileName}_${Date.now()}.log`);
     this.maxSize = size;
     this.fileName = logFileName;
+    this.type = type;
   }
   log(msg, logType = "DEBUG") {
     if (!this.logging)
       return;
-    this.checkPathExistance();
+    const path = this.checkPathExistance(logType);
     const content = `${logType}:[${(/* @__PURE__ */ new Date()).toISOString()}]:${msg}
 `;
     try {
-      appendFileSync(this.logPath, content);
+      appendFileSync(path, content);
     } catch (err) {
       console.error(`Failed to write to log file: ${err}`);
     }
     try {
       existsSync(this.logPath);
-      this.checkLogSize();
+      this.checkLogSize(path);
     } catch {
       console.log("Log file not exists");
     }
   }
-  checkLogSize() {
-    const dirName = dirname(this.logPath);
+  checkLogSize(path) {
+    const dirName = dirname(path);
     try {
-      const stats = statSync(this.logPath);
+      const stats = statSync(path);
       if (stats.size >= this.maxSize) {
         this.logPath = resolve(dirName, `${this.fileName}_${Date.now()}.log`);
-        this.deleteOldestFile();
+        this.deleteOldestFile(path);
       }
     } catch (err) {
       console.log("File not found");
     }
   }
-  deleteOldestFile() {
-    const dirName = dirname(this.logPath);
+  deleteOldestFile(path) {
+    const dirName = dirname(path);
     const files = readdirSync(dirName);
     const currentDate = /* @__PURE__ */ new Date();
     const sevenDaysAgo = (/* @__PURE__ */ new Date()).setDate(currentDate.getDate() - 7);
@@ -200,11 +202,13 @@ var Logger = class {
       }
     }
   }
-  async checkPathExistance() {
-    const pathExists = existsSync(this.logPath);
+  checkPathExistance(type) {
+    const path = this.type === "SEPARATE" ? `${this.logPath.split(".")[0]}_${type.toLowerCase()}.log` : this.logPath;
+    const pathExists = existsSync(path);
     if (!pathExists) {
       mkdirSync(dirname(this.logPath), { recursive: true });
     }
+    return path;
   }
 };
 var logger_default = Logger;
@@ -726,6 +730,7 @@ var WebsocketClient = class extends EventEmitter {
   reconnectTimer;
   subscribedTokens = [];
   logger;
+  maxRetryAttempt;
   /**
    *
    * @param params
@@ -734,12 +739,19 @@ var WebsocketClient = class extends EventEmitter {
   constructor(params) {
     super();
     const {
-      reconnectInterval = 3e3,
+      reconnectInterval = 3e4,
       dailyRefreshTime = "09:10+05:30",
       cred,
-      logging = false
+      logging = false,
+      logFileType = "SEPARATE",
+      maxRetryAttepmt = 3
     } = params || {};
-    this.logger = new logger_default("shoonya_ws-client", 1024 * 1024);
+    this.maxRetryAttempt = maxRetryAttepmt;
+    this.logger = new logger_default(
+      "shoonya_ws-client",
+      1024 * 1024 * 10,
+      logFileType
+    );
     this.logger.logging ||= logging;
     const storedCred = tokens.getCred();
     const c = storedCred.userId ? storedCred : cred;
@@ -785,7 +797,7 @@ var WebsocketClient = class extends EventEmitter {
   };
   wsMessageEvent = (msg) => {
     const result = JSON.parse(msg.toString());
-    if (result.t === "ck") {
+    if (result.t === "ck" && result.s.toLowerCase() === "ok") {
       console.log("Connected with Shoonya Websocket.");
       this.logger.log("|WSClient| Connected with Shoonya WS.");
       clearInterval(this.reconnectTimer);
@@ -820,6 +832,7 @@ var WebsocketClient = class extends EventEmitter {
     if (code === 1) {
       try {
         await refreshAccessToken();
+        this.logger.log("Access Token Refreshed");
       } catch (err) {
         err instanceof Error && this.logger.log(err.message, "ERROR");
       }
@@ -828,10 +841,18 @@ var WebsocketClient = class extends EventEmitter {
       return;
     }
     if (code !== 0) {
-      this.logger.log("Disconnected. Attempting to reconnect....");
+      let retryAttempts = 0;
       clearInterval(this.reconnectTimer);
       this.reconnectTimer = setInterval(() => {
+        retryAttempts++;
+        this.logger.log(
+          `Disconnected with error code ${code}. Attempt ${retryAttempts} to reconnect....`
+        );
         this.connect();
+        if (this.maxRetryAttempt === retryAttempts) {
+          this.logger.log("Max Retry Attempt Reached. Stopped Retrying.");
+          clearInterval(this.reconnectInterval);
+        }
       }, this.reconnectInterval);
       return;
     }
@@ -860,6 +881,9 @@ var WebsocketClient = class extends EventEmitter {
       // unsubcribe depth subscription
       k: scripList.join("#")
     };
+    this.subscribedTokens = this.subscribedTokens.filter(
+      (item) => !scripList.includes(item)
+    );
     this.send(msg);
   }
   resubscribe() {
@@ -882,6 +906,7 @@ var WebsocketClient = class extends EventEmitter {
       const currentMin = date.getUTCMinutes();
       const currentHour = date.getUTCHours();
       if (lastMin !== min && hour === currentHour && min === currentMin) {
+        this.logger.log("refreshing access token");
         this.ws.close(1);
         lastMin = min;
         return;

package/package.json

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