firstock 1.0.0 → 1.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Firstock Broking Private Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Readme.md

@@ -1,7 +1,8 @@
+
 # The Firstock Developer API Nodejs client - 
 
 To communicate with the Firstock Developer API using Nodejs, you can use the official Nodejs client library provided by Firstock.
-`<br />` Licensed under the MIT License.
+Licensed under the MIT License.
 
 
 [Version - 1.0.0](https://www.npmjs.com/package/firstock)
@@ -11,11 +12,6 @@ To communicate with the Firstock Developer API using Nodejs, you can use the off
 
 * Nodejs client documentation
 
-## v3 - Changes
-
-* Error code response structured has been changed
-* Renamed
-
 ## Installing the client
 
 Use the package manager [npm](https://www.npmjs.com/) to install thefirstock.
@@ -288,3 +284,9 @@ Refer to the [Firstock Connect Documentation](https://connect.thefirstock.com/)
 ## Changelog
 
 Check release notes.
+
+
+
+
+
+

package/dist/Classes/Firstock.js

@@ -36,6 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Firstock = void 0;
 const axios_1 = __importDefault(require("axios"));
 const sha256 = __importStar(require("sha256"));
 const AFirstock_1 = __importDefault(require("./AFirstock"));
@@ -932,8 +933,8 @@ class Firstock extends AFirstock_1.default {
                         callBack(err, null);
                     }
                     else if (jKey) {
-                        axiosInterceptor
-                            .post(`productConversion`, {
+                        // Prepare the request payload
+                        const requestPayload = {
                             userId,
                             jKey,
                             exchange: params.exchange,
@@ -941,7 +942,13 @@ class Firstock extends AFirstock_1.default {
                             quantity: params.quantity,
                             product: params.product,
                             previousProduct: params.previousProduct,
-                        })
+                        };
+                        // Add msgFlag to payload if provided
+                        if (params.msgFlag) {
+                            requestPayload.msgFlag = params.msgFlag;
+                        }
+                        axiosInterceptor
+                            .post(`productConversion`, requestPayload)
                             .then((response) => {
                             const { data } = response;
                             callBack(null, data);
@@ -1766,5 +1773,53 @@ class Firstock extends AFirstock_1.default {
             }
         });
     }
+    /**
+     * Retrieves holdings details for a user from the Firstock API.
+     *
+     * This method sends a request to the Firstock holdingsDetails endpoint using the provided
+     * user ID and session token (jKey) retrieved from config.json. The response contains the user's holdings information.
+     *
+     * @param {Object} params - Holdings parameters.
+     * @param {string} params.userId - Firstock user ID (e.g., SU2707).
+     * @param {function} callBack - Callback with `(error, result)`:
+     * - `error`: Error object if the request fails.
+     * - `result`: Parsed response containing holdings information if successful.
+     */
+    getHoldingsDetails({ userId }, callBack) {
+        (0, commonFunction_1.readData)((err, data) => {
+            if (err) {
+                const errorMessage = err instanceof Error ? err.message : err;
+                callBack(new Error((0, commonFunction_1.errorMessageMapping)({ message: errorMessage })), null);
+            }
+            else if (data) {
+                (0, commonFunction_1.checkifUserLoggedIn)({ userId, jsonData: data }, (err, jKey) => {
+                    if (err) {
+                        callBack(new Error(err), null);
+                    }
+                    else if (jKey) {
+                        axiosInterceptor
+                            .post("holdingsDetails", {
+                            userId,
+                            jKey
+                        })
+                            .then((response) => {
+                            const { data } = response;
+                            this.userId = userId;
+                            callBack(null, data);
+                        })
+                            .catch((error) => {
+                            callBack((0, commonFunction_1.handleError)(error), null);
+                        });
+                    }
+                    else {
+                        callBack(new Error("No jKey found for userId in config.json"), null);
+                    }
+                });
+            }
+            else {
+                callBack(new Error("No config data found"), null);
+            }
+        });
+    }
 }
-exports.default = Firstock;
+exports.Firstock = Firstock;

package/dist/index.js

@@ -1,7 +1,3 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const Firstock_1 = __importDefault(require("./Classes/Firstock"));
-exports.default = Firstock_1.default;
+const Firstock_1 = require("./Classes/Firstock");
+module.exports = Firstock_1.Firstock;

package/dist/shared/commonFunction.js

@@ -45,7 +45,20 @@ const readData = (callback) => {
     const path = "./config.json";
     fs.readFile(path, "utf-8", (err, jsonString) => {
         if (err) {
-            callback(err, null);
+            if (err.code === "ENOENT") {
+                // File not found: create it with "{}"
+                fs.writeFile(path, "{}", "utf-8", (writeErr) => {
+                    if (writeErr) {
+                        callback(writeErr, null);
+                    }
+                    else {
+                        callback(null, {}); // Return an empty object
+                    }
+                });
+            }
+            else {
+                callback(err, null);
+            }
         }
         else {
             try {

package/dist/test.js

@@ -3,17 +3,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const Firstock_1 = __importDefault(require("./Classes/Firstock"));
-const firstock = new Firstock_1.default();
+const index_1 = __importDefault(require("./index"));
+const firstock = new index_1.default();
 let orderNumber = "";
-const userDetails = {
-    userId: "",
-    password: "",
-    TOTP: "",
-    vendorCode: "",
-    apiKey: "",
-};
-// Login and user Details start
+// const userDetails = {
+//   userId: "NP2997",
+//   password: "Skanda@202",
+//   TOTP: "1997",
+//   vendorCode: "NP2997_API",
+//   apiKey: "65d837ab42a4b0000fbe05f37ee575fb",
+// };
+// const userDetails = {
+//   userId: "",
+//   password: "",
+//   TOTP: "",
+//   vendorCode: "",
+//   apiKey: "",
+// };
+// // Login and user Details start
 // firstock.login(
 //   {
 //     userId: userDetails.userId,
@@ -155,6 +162,21 @@ const userDetails = {
 //     console.log("productConversion Result: ", result);
 //   }
 // );
+// firstock.productConversion(
+//   {
+//     userId: userDetails.userId,
+//     exchange: "NFO",
+//     tradingSymbol: "NIFTY",
+//     quantity: "250",
+//     product: "C",
+//     previousProduct: "I",
+//     msgFlag: "1" // Buy and Day
+//   },
+//   (err: Error | string | null, result: any) => {
+//     console.log("productConversion (Buy & Day) Error: ", err);
+//     console.log("productConversion (Buy & Day) Result: ", result);
+//   }
+// );
 // Holdings
 // firstock.holdings(
 //   { userId: userDetails.userId},//, product: "C" 
@@ -335,6 +357,16 @@ const userDetails = {
 //     console.log("brokerageCalculator Result: ", result)
 //   }
 // )
+// Get Holdings Details
+// firstock.getHoldingsDetails(
+//   {
+//     userId: userDetails.userId
+//     },
+//   (err: Error | null, result: any) => {
+//     console.log("Error: ", err);
+//     console.log("Result: ", result);
+//   }
+// );
 // Logout
 // firstock.logout(
 //   { userId: userDetails.userId },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firstock",
-  "version": "1.0.0",
+  "version": "1.0.4",
   "description": "Node js package for using firstock developer apis",
   "main": "dist/index.js",
   "type": "commonjs",

package/Classes/AFirstock.ts

@@ -1,371 +0,0 @@
-interface Response {
-  data: {
-    [key: string]: any;
-  };
-}
-
-interface LoginParams {
-  userId: string;
-  password: string;
-  TOTP: string;
-  vendorCode: string;
-  apiKey: string;
-  [key: string]: any;
-}
-
-interface ConfigData {
-  [key: string]: {
-    jKey: string;
-  };
-}
-
-interface PlaceOrderParams {
-  userId: string;
-  exchange: string;
-  tradingSymbol: string;
-  quantity: string | number;
-  price: string | number;
-  product: string;
-  transactionType: string;
-  priceType: string;
-  retention: string;
-  remarks: string;
-  triggerPrice: string;
-  [key: string]: any;
-}
-
-interface CancelOrderParams {
-  userId: string;
-  orderNumber: string;
-  [key: string]: any;
-}
-
-interface ModifyOrderParams {
-  userId: string;
-  orderNumber: string;
-  price: string | number;
-  quantity: string | number;
-  triggerPrice: string | number;
-  tradingSymbol: string;
-  exchange: string;
-  priceType: string;
-  product: string;
-  retention: string;
-  [key: string]: any;
-}
-
-interface BasketItem {
-  exchange: string;
-  transactionType: string;
-  product: string;
-  tradingSymbol: string;
-  quantity: string | number;
-  priceType: string;
-  price: string | number;
-  [key: string]: any;
-}
-
-interface BasketMarginParams {
-  userId: string;
-  BasketList_Params: BasketItem[];
-  [key: string]: any;
-}
-
-interface SingleOrderHistoryParams {
-  userId: string;
-  orderNumber: string;
-  [key: string]: any;
-}
-
-interface UserDetailsParams {
-  userId: string;
-  [key: string]: any;
-}
-
-interface OrderMarginParams {
-  userId: string;
-  exchange: string;
-  tradingSymbol: string;
-  quantity: string | number;
-  price: string | number;
-  product: string;
-  transactionType: string;
-  priceType: string;
-  [key: string]: any;
-}
-
-interface ProductConversionParams {
-  userId: string;
-  exchange: string;
-  tradingSymbol: string;
-  quantity: string | number;
-  product: string;
-  previousProduct: string;
-  transactionType?: string;
-  positionType?: string;
-  [key: string]: any;
-}
-
-interface OrderBookParams {
-  userId: string;
-  [key: string]: any;
-}
-
-interface TradeBookParams {
-  userId: string;
-  [key: string]: any;
-}
-
-interface PositionsBookParams {
-  userId: string;
-  [key: string]: any;
-}
-
-interface MultiQuoteItem {
-  exchange: string;
-  tradingSymbol: string;
-  [key: string]: any;
-}
-
-interface GetMultiQuotesParams {
-  userId: string;
-  data: MultiQuoteItem[];
-  [key: string]: any;
-}
-
-interface GetQuoteLTPParams {
-  userId: string;
-  exchange: string;
-  tradingSymbol: string;
-  [key: string]: any;
-}
-
-interface GetMultiQuotesLTPParams {
-  userId: string;
-  data: MultiQuoteItem[];
-  [key: string]: any;
-}
-
-interface SearchScriptsParams {
-  userId: string;
-  stext: string;
-  [key: string]: any;
-}
-
-interface GetSecurityInfoParams {
-  userId: string;
-  exchange: string;
-  tradingSymbol: string;
-  [key: string]: any;
-}
-
-interface HoldingsParams {
-  userId: string;
-  product?: string;
-  [key: string]: any;
-}
-
-interface LimitsParams {
-  userId: string;
-  [key: string]: any;
-}
-
-interface GetQuotesParams {
-  userId: string;
-  exchange: string;
-  tradingSymbol: string;
-  [key: string]: any;
-}
-
-interface GetIndexListParams {
-  userId: string;
-  exchange: string;
-  [key: string]: any;
-}
-
-interface GetOptionChainParams {
-  userId: string;
-  exchange: string;
-  symbol: string;
-  strikePrice: string | number;
-  count: string | number;
-  expiry?: string;
-  [key: string]: any;
-}
-
-interface TimePriceSeriesParams {
-  userId: string;
-  exchange: string;
-  tradingSymbol: string;
-  endTime: string;
-  startTime: string;
-  interval: string | number;
-  [key: string]: any;
-}
-
-interface BrokerageCalculatorParams {
-  userId: string;
-  exchange: string;
-  tradingSymbol: string;
-  transactionType: string;
-  Product: string;
-  quantity: string | number;
-  price: string | number;
-  strike_price: string | number;
-  inst_name: string;
-  lot_size: string | number;
-  [key: string]: any;
-}
-
-interface GetExpiryParams {
-  userId: string;
-  exchange: string;
-  tradingSymbol: string;
-  [key: string]: any;
-}
-  
-  
-  abstract class AFirstock {
-    constructor() {
-      if (this.constructor === AFirstock) {
-        throw new Error("Abstract classes can't be instantiated.");
-      }
-    }
-  
-    abstract getPosts(): Promise<any>;
-  
-    abstract getUsers(): any;
-  
-    abstract getPostByUserId(): any;
-  
-    abstract login(
-      params: LoginParams,
-      callBack: (error: Error | null, result: Response | null) => void
-    ): void;
-  
-    abstract logout(
-      params: { userId: string },
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;
-
-    abstract userDetails(
-      params: UserDetailsParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;
-
-    abstract placeOrder(
-      params: PlaceOrderParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;  
-
-    abstract orderMargin(
-      params: OrderMarginParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;   
-
-    abstract cancelOrder(
-      params: CancelOrderParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;
-
-    abstract modifyOrder(
-      params: ModifyOrderParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;
-
-    abstract singleOrderHistory(
-      params: SingleOrderHistoryParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;
-    abstract orderBook(
-      params: OrderBookParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;
-  
-    abstract tradeBook(
-      params: TradeBookParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;
-  
-    abstract positionBook(
-      params: PositionsBookParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;
-  
-    abstract productConversion(
-      params: ProductConversionParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;  
-    
-    abstract holdings(
-      params: HoldingsParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;
-
-    abstract limit(
-      params: LimitsParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;
-
-    abstract basketMargin(
-      params: BasketMarginParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;
-    
-    abstract getQuote(
-      params: GetQuotesParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;  
-
-    abstract getQuoteltp(
-      params: GetQuoteLTPParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;  
-
-    abstract getMultiQuotesltp(
-      params: GetMultiQuotesLTPParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void; 
-
-    abstract getMultiQuotes(
-      params: GetMultiQuotesParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void; 
-
-    abstract searchScrips(
-      params: SearchScriptsParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;  
-
-    abstract securityInfo(
-      params: GetSecurityInfoParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;  
-
-    abstract indexList(
-      params: GetIndexListParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;
-    
-    abstract optionChain(
-      params: GetOptionChainParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;
-      
-    abstract timePriceSeries(
-      params: TimePriceSeriesParams,
-      callBack: (error: Error | string | null, result: Response | null) => void
-    ): void;
-
-    abstract getExpiry(
-        params: GetExpiryParams,
-        callBack: (error: Error | string | null, result: Response | null) => void
-      ): void;
-
-    abstract brokerageCalculator(
-        params: BrokerageCalculatorParams,
-        callBack: (error: Error | string | null, result: Response | null) => void
-      ): void;
-  }
-  
-  export default AFirstock;