shoonya-sdk 0.3.1

package/README.md

@@ -0,0 +1,3 @@
+# Shoonya SDK for TimeWarp
+
+Wrapper around Shoonya API

package/dist/shoonya-sdk.d.mts

@@ -0,0 +1,335 @@
+import { EventEmitter } from 'events';
+
+declare const paths: {
+    readonly login: "QuickAuth";
+    readonly logout: "Logout";
+    readonly forgotPassword: "ForgotPassword";
+    readonly changePassword: "Changepwd";
+    readonly watchlist: "MWList";
+    readonly getWatchlist: "MarketWatch";
+    readonly searchScrip: "SearchScrip";
+    readonly userInfo: "UserDetails";
+    readonly clientInfo: "ClientDetails";
+    readonly quotes: "GetQuotes";
+    readonly addScripToWL: "AddMultiScripsToMW";
+    readonly removeScripFromWL: "DeleteMultiMWScrips";
+    readonly securityInfo: "GetSecurityInfo";
+    readonly placeOrder: "PlaceOrder";
+    readonly modifyOrder: "ModifyOrder";
+    readonly cancelOrder: "CancelOrder";
+    readonly exitSNOOrder: "ExitSNOOrder";
+    readonly historicData: "TPSeries";
+    readonly optionChain: "GetOptionChain";
+    readonly orderBook: "OrderBook";
+};
+type Path = keyof typeof paths;
+
+type LogType = "INFO" | "WARN" | "ERROR";
+declare class Logger {
+    private logPath;
+    private maxSize;
+    /**
+     *
+     * @param logPath path of the log file
+     * @param maxSize max size a log file should have (in bytes)
+     */
+    constructor(logPath: string, maxSize: number);
+    private checkLogSize;
+    log(message: string, type?: LogType): void;
+    getRecentLog(): string;
+    private deleteOldestFile;
+}
+
+type RequestDataType = {
+    [key: string]: string;
+};
+type MakeKeysRequired<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
+interface UserCred {
+    userId: string;
+    password: string;
+    twoFa: string;
+    apiKey: string;
+    imei?: string;
+    vendorCode?: string;
+}
+interface OrderInput {
+    uid?: string;
+    /**
+     * Same as userId
+     */
+    actid?: string;
+    exch: "NSE" | "NFO" | "CDS" | "MCX" | "BSE";
+    /**
+     * Unique id of contract on which order to be placed.
+     *
+     * (Use the Results from Search Script to get the trading symbol & use url encoding to avoid special char error for symbols like M&M)
+     */
+    tsym: string;
+    /**
+     * Order Quantity
+     */
+    qty: string;
+    /**
+     * Order Price
+     */
+    prc: string;
+    /**
+     * Only to be sent in case of SL / SL-M order.
+     */
+    trgprc?: string;
+    /**
+     * 	Disclosed quantity (Max 10% for NSE, and 50% for MCX)
+     */
+    dscqty: string;
+    /**
+     * Product Name
+     * (Select from ‘prarr’ Array provided in User Details response, and if same is allowed for selected, exchange.
+     *  Show product display name, for user to select, and send corresponding prd in API call)
+     *
+     * ```
+     *  `C` : CNC
+     *  `M` : NRML
+     *  `I` : MIS
+     *  `B` : Bracket Order
+     *  `H` : Cover Order
+     * ```
+     */
+    prd: "C" | "M" | "I" | "B" | "H";
+    /**
+     * Transaction Type
+     * ```
+     * `B` : "Buy"
+     * `S` : "Sell"
+     * ```
+     */
+    trantype: "B" | "S";
+    prctyp: "LMT" | "MKT" | "SL-LMT" | "SL-MKT" | "DS" | "2L" | "3L";
+    /**
+     * Retention Type (Show options as per allowed exchanges)
+     */
+    ret: "DAY" | "EOS" | "IOC";
+    /**
+     * Any tag by user to mark order
+     */
+    remarks?: string;
+    /**
+     * 	Noren order number, which needs to be modified
+     */
+    norenordno?: string;
+}
+interface BaseResponse<T> {
+    stat: "Ok" | "Not_Ok";
+    values: T[];
+    emsg?: string;
+}
+interface SearchScripValues {
+    exch: "NSE" | "BSE" | "NFO" | "MCX";
+    tsym: string;
+    token: string;
+    pp: string;
+    ti: string;
+    ls: string;
+}
+interface SearchScripResponse extends BaseResponse<SearchScripValues> {
+    request_time?: string;
+}
+interface OptionChainValue extends SearchScripValues {
+    /**
+     * Option Type
+     */
+    optt: string;
+    /**
+     * Strike Price
+     */
+    strprc: string;
+}
+interface OptionChainResponse extends BaseResponse<OptionChainValue> {
+}
+type PlaceOrder = {
+    stat: "Ok" | "Not_Ok";
+    request_time?: string;
+    norenordno?: string;
+    emsg?: string;
+};
+interface OrderBookSuccess {
+    stat: "Ok";
+    exch: "NSE" | "BSE" | "NFO" | "MCX";
+    /**
+     * Trading Symbol
+     */
+    tsym: string;
+    norenordno: string;
+    /**
+     * Price
+     */
+    prc: string;
+    qty: string;
+    /**
+     * Product Alias Name
+     */
+    prd: string;
+    status: string;
+    trantype: "B" | "S";
+    /**
+     * Price Type
+     */
+    prctyp: "LMT" | "MKT";
+    fillshares: string;
+    avgprc: string;
+    /**
+     * Exchange Order Number
+     */
+    exchordid: string;
+    /**
+     * Reject Reason
+     */
+    rejreason?: string;
+    cancelqty?: string;
+    remarks?: string;
+    dscqty?: string;
+    uid: string;
+    actid: string;
+    ret: "DAY" | "IOC" | "EOS";
+    amo: "Yes" | "No";
+    exch_tm: string;
+    norentm: string;
+}
+interface OrderBookFail {
+    stat: "Not_Ok";
+    request_time: string;
+    emsg: string;
+}
+type OrderBook = OrderBookSuccess[] | OrderBookFail;
+
+declare class Shoonya extends EventEmitter {
+    accessToken: string;
+    userId: string;
+    logger: Logger;
+    private logging;
+    private readonly httpBaseUrl;
+    private readonly wsBaseUrl;
+    private ws;
+    private connectTimer;
+    private disconnectTimer;
+    private accountId;
+    private twoFa;
+    private password;
+    private apiKey;
+    private cronJobRunning;
+    private scripList;
+    constructor(options?: {
+        logging: boolean;
+    });
+    request<T>(path: Path, body: {
+        data: RequestDataType;
+        key?: string;
+    }): Promise<T>;
+    /**
+     *
+     * @param credentials User Credential (username, password, appkeys etc.)
+     * @returns user information and access token
+     */
+    login(rawCred: UserCred): Promise<any>;
+    /**
+     * @param query scrip name (BankNifty, Sensex etc.)
+     * @param exchange exchange name (NSE, BSE etc.)
+     * @returns
+     */
+    searchScrip(query: string, exchange: string): Promise<SearchScripResponse>;
+    getWatchlistsName(): Promise<unknown>;
+    getWatchlist(listName: string): Promise<unknown>;
+    forgetPassword(PAN: string, DOB: string): Promise<unknown>;
+    /**
+     *
+     * @param oldPass sha256 of old pass
+     * @param newPass new password in plain text
+     * @returns
+     */
+    changePassword(oldPass: string, newPass: string): Promise<unknown>;
+    getUserDetails(): Promise<unknown>;
+    /**
+     * @param brokerId logged in user's brokers Name / Id
+     * @returns
+     */
+    getClientDetails(brokerId: string): Promise<unknown>;
+    getQuotes(exchange: string, contractToken: string): Promise<unknown>;
+    /**
+     *
+     * @param listName name of watchlist in which user want to add script
+     * @param scrips list of the scrip
+     * @returns
+     */
+    addScripToWatchList(listName: string, scrips: string[]): Promise<unknown>;
+    /**
+     *
+     * @param listName name of watchlist in which user want to add script
+     * @param scrips list of the scrip
+     * @returns
+     */
+    removeScripFromWatchList(listName: string, scrips: string[]): Promise<unknown>;
+    getSecurityInfo(exchange: string, contractToken: string): Promise<unknown>;
+    placeOrder(details: OrderInput): Promise<PlaceOrder>;
+    modifyOrder(orderDetail: MakeKeysRequired<Partial<OrderInput>, "exch" | "norenordno" | "tsym">): Promise<unknown>;
+    cancelOrder(orderNo: string): Promise<unknown>;
+    /**
+     *
+     * @param orderNo Noren order number, which needs to be modified
+     * @param product Allowed for only H and B products (Cover order and bracket order)
+     * @returns
+     */
+    exitSNOOrder(orderNo: string, product: "H" | "B"): Promise<unknown>;
+    getHistoricData(option: {
+        exch: string;
+        token: string;
+        st?: string;
+        et?: string;
+    }): Promise<unknown>;
+    getOptionChain(option: {
+        tradingSymbol: string;
+        exchange: string;
+        midPrice: string;
+        count: string;
+    }): Promise<OptionChainResponse>;
+    orderBook(prd: "C" | "M" | "I" | "B" | "H"): Promise<OrderBook>;
+    /**
+     * Its a custom method which will return token number of option
+     * it can be used to start websocket connection to that tokenƒ
+     *
+     * @param params info about symbol
+     * @returns
+     */
+    getOptionToken(params: {
+        symbol: string;
+        strikePrice: number;
+        optionType: "CE" | "PE";
+        exchange?: "NFO" | "MCX";
+        /**
+         * Count of option in each side. default 5 on ITM and 5 OTM
+         * @default 5
+         */
+        count?: string;
+    }): Promise<{
+        token: string;
+        exchange: "NFO" | "MCX";
+        tsym: string;
+    }>;
+    private getFormattedExpiry;
+    private getNext7FormattedDate;
+    connectWS(): void;
+    /**
+     *
+     * subscribes for list of scrip by which WS returns them every time their price changes.
+     *
+     * `searchScrip` method can be used to get scripToken from scripName
+     * @param scripList scrip list requires list of scrip name in format of `exchangeName|scripToken`
+     */
+    subscribe(scripList: string[]): void;
+    unsubscribe(scripList: string[]): void;
+    subscribeOrderUpdate(): void;
+    unsubscribeOrderUpdate(): void;
+    disconnect(): void;
+}
+
+export { Shoonya };

package/dist/shoonya-sdk.d.ts

@@ -0,0 +1,335 @@
+import { EventEmitter } from 'events';
+
+declare const paths: {
+    readonly login: "QuickAuth";
+    readonly logout: "Logout";
+    readonly forgotPassword: "ForgotPassword";
+    readonly changePassword: "Changepwd";
+    readonly watchlist: "MWList";
+    readonly getWatchlist: "MarketWatch";
+    readonly searchScrip: "SearchScrip";
+    readonly userInfo: "UserDetails";
+    readonly clientInfo: "ClientDetails";
+    readonly quotes: "GetQuotes";
+    readonly addScripToWL: "AddMultiScripsToMW";
+    readonly removeScripFromWL: "DeleteMultiMWScrips";
+    readonly securityInfo: "GetSecurityInfo";
+    readonly placeOrder: "PlaceOrder";
+    readonly modifyOrder: "ModifyOrder";
+    readonly cancelOrder: "CancelOrder";
+    readonly exitSNOOrder: "ExitSNOOrder";
+    readonly historicData: "TPSeries";
+    readonly optionChain: "GetOptionChain";
+    readonly orderBook: "OrderBook";
+};
+type Path = keyof typeof paths;
+
+type LogType = "INFO" | "WARN" | "ERROR";
+declare class Logger {
+    private logPath;
+    private maxSize;
+    /**
+     *
+     * @param logPath path of the log file
+     * @param maxSize max size a log file should have (in bytes)
+     */
+    constructor(logPath: string, maxSize: number);
+    private checkLogSize;
+    log(message: string, type?: LogType): void;
+    getRecentLog(): string;
+    private deleteOldestFile;
+}
+
+type RequestDataType = {
+    [key: string]: string;
+};
+type MakeKeysRequired<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
+interface UserCred {
+    userId: string;
+    password: string;
+    twoFa: string;
+    apiKey: string;
+    imei?: string;
+    vendorCode?: string;
+}
+interface OrderInput {
+    uid?: string;
+    /**
+     * Same as userId
+     */
+    actid?: string;
+    exch: "NSE" | "NFO" | "CDS" | "MCX" | "BSE";
+    /**
+     * Unique id of contract on which order to be placed.
+     *
+     * (Use the Results from Search Script to get the trading symbol & use url encoding to avoid special char error for symbols like M&M)
+     */
+    tsym: string;
+    /**
+     * Order Quantity
+     */
+    qty: string;
+    /**
+     * Order Price
+     */
+    prc: string;
+    /**
+     * Only to be sent in case of SL / SL-M order.
+     */
+    trgprc?: string;
+    /**
+     * 	Disclosed quantity (Max 10% for NSE, and 50% for MCX)
+     */
+    dscqty: string;
+    /**
+     * Product Name
+     * (Select from ‘prarr’ Array provided in User Details response, and if same is allowed for selected, exchange.
+     *  Show product display name, for user to select, and send corresponding prd in API call)
+     *
+     * ```
+     *  `C` : CNC
+     *  `M` : NRML
+     *  `I` : MIS
+     *  `B` : Bracket Order
+     *  `H` : Cover Order
+     * ```
+     */
+    prd: "C" | "M" | "I" | "B" | "H";
+    /**
+     * Transaction Type
+     * ```
+     * `B` : "Buy"
+     * `S` : "Sell"
+     * ```
+     */
+    trantype: "B" | "S";
+    prctyp: "LMT" | "MKT" | "SL-LMT" | "SL-MKT" | "DS" | "2L" | "3L";
+    /**
+     * Retention Type (Show options as per allowed exchanges)
+     */
+    ret: "DAY" | "EOS" | "IOC";
+    /**
+     * Any tag by user to mark order
+     */
+    remarks?: string;
+    /**
+     * 	Noren order number, which needs to be modified
+     */
+    norenordno?: string;
+}
+interface BaseResponse<T> {
+    stat: "Ok" | "Not_Ok";
+    values: T[];
+    emsg?: string;
+}
+interface SearchScripValues {
+    exch: "NSE" | "BSE" | "NFO" | "MCX";
+    tsym: string;
+    token: string;
+    pp: string;
+    ti: string;
+    ls: string;
+}
+interface SearchScripResponse extends BaseResponse<SearchScripValues> {
+    request_time?: string;
+}
+interface OptionChainValue extends SearchScripValues {
+    /**
+     * Option Type
+     */
+    optt: string;
+    /**
+     * Strike Price
+     */
+    strprc: string;
+}
+interface OptionChainResponse extends BaseResponse<OptionChainValue> {
+}
+type PlaceOrder = {
+    stat: "Ok" | "Not_Ok";
+    request_time?: string;
+    norenordno?: string;
+    emsg?: string;
+};
+interface OrderBookSuccess {
+    stat: "Ok";
+    exch: "NSE" | "BSE" | "NFO" | "MCX";
+    /**
+     * Trading Symbol
+     */
+    tsym: string;
+    norenordno: string;
+    /**
+     * Price
+     */
+    prc: string;
+    qty: string;
+    /**
+     * Product Alias Name
+     */
+    prd: string;
+    status: string;
+    trantype: "B" | "S";
+    /**
+     * Price Type
+     */
+    prctyp: "LMT" | "MKT";
+    fillshares: string;
+    avgprc: string;
+    /**
+     * Exchange Order Number
+     */
+    exchordid: string;
+    /**
+     * Reject Reason
+     */
+    rejreason?: string;
+    cancelqty?: string;
+    remarks?: string;
+    dscqty?: string;
+    uid: string;
+    actid: string;
+    ret: "DAY" | "IOC" | "EOS";
+    amo: "Yes" | "No";
+    exch_tm: string;
+    norentm: string;
+}
+interface OrderBookFail {
+    stat: "Not_Ok";
+    request_time: string;
+    emsg: string;
+}
+type OrderBook = OrderBookSuccess[] | OrderBookFail;
+
+declare class Shoonya extends EventEmitter {
+    accessToken: string;
+    userId: string;
+    logger: Logger;
+    private logging;
+    private readonly httpBaseUrl;
+    private readonly wsBaseUrl;
+    private ws;
+    private connectTimer;
+    private disconnectTimer;
+    private accountId;
+    private twoFa;
+    private password;
+    private apiKey;
+    private cronJobRunning;
+    private scripList;
+    constructor(options?: {
+        logging: boolean;
+    });
+    request<T>(path: Path, body: {
+        data: RequestDataType;
+        key?: string;
+    }): Promise<T>;
+    /**
+     *
+     * @param credentials User Credential (username, password, appkeys etc.)
+     * @returns user information and access token
+     */
+    login(rawCred: UserCred): Promise<any>;
+    /**
+     * @param query scrip name (BankNifty, Sensex etc.)
+     * @param exchange exchange name (NSE, BSE etc.)
+     * @returns
+     */
+    searchScrip(query: string, exchange: string): Promise<SearchScripResponse>;
+    getWatchlistsName(): Promise<unknown>;
+    getWatchlist(listName: string): Promise<unknown>;
+    forgetPassword(PAN: string, DOB: string): Promise<unknown>;
+    /**
+     *
+     * @param oldPass sha256 of old pass
+     * @param newPass new password in plain text
+     * @returns
+     */
+    changePassword(oldPass: string, newPass: string): Promise<unknown>;
+    getUserDetails(): Promise<unknown>;
+    /**
+     * @param brokerId logged in user's brokers Name / Id
+     * @returns
+     */
+    getClientDetails(brokerId: string): Promise<unknown>;
+    getQuotes(exchange: string, contractToken: string): Promise<unknown>;
+    /**
+     *
+     * @param listName name of watchlist in which user want to add script
+     * @param scrips list of the scrip
+     * @returns
+     */
+    addScripToWatchList(listName: string, scrips: string[]): Promise<unknown>;
+    /**
+     *
+     * @param listName name of watchlist in which user want to add script
+     * @param scrips list of the scrip
+     * @returns
+     */
+    removeScripFromWatchList(listName: string, scrips: string[]): Promise<unknown>;
+    getSecurityInfo(exchange: string, contractToken: string): Promise<unknown>;
+    placeOrder(details: OrderInput): Promise<PlaceOrder>;
+    modifyOrder(orderDetail: MakeKeysRequired<Partial<OrderInput>, "exch" | "norenordno" | "tsym">): Promise<unknown>;
+    cancelOrder(orderNo: string): Promise<unknown>;
+    /**
+     *
+     * @param orderNo Noren order number, which needs to be modified
+     * @param product Allowed for only H and B products (Cover order and bracket order)
+     * @returns
+     */
+    exitSNOOrder(orderNo: string, product: "H" | "B"): Promise<unknown>;
+    getHistoricData(option: {
+        exch: string;
+        token: string;
+        st?: string;
+        et?: string;
+    }): Promise<unknown>;
+    getOptionChain(option: {
+        tradingSymbol: string;
+        exchange: string;
+        midPrice: string;
+        count: string;
+    }): Promise<OptionChainResponse>;
+    orderBook(prd: "C" | "M" | "I" | "B" | "H"): Promise<OrderBook>;
+    /**
+     * Its a custom method which will return token number of option
+     * it can be used to start websocket connection to that tokenƒ
+     *
+     * @param params info about symbol
+     * @returns
+     */
+    getOptionToken(params: {
+        symbol: string;
+        strikePrice: number;
+        optionType: "CE" | "PE";
+        exchange?: "NFO" | "MCX";
+        /**
+         * Count of option in each side. default 5 on ITM and 5 OTM
+         * @default 5
+         */
+        count?: string;
+    }): Promise<{
+        token: string;
+        exchange: "NFO" | "MCX";
+        tsym: string;
+    }>;
+    private getFormattedExpiry;
+    private getNext7FormattedDate;
+    connectWS(): void;
+    /**
+     *
+     * subscribes for list of scrip by which WS returns them every time their price changes.
+     *
+     * `searchScrip` method can be used to get scripToken from scripName
+     * @param scripList scrip list requires list of scrip name in format of `exchangeName|scripToken`
+     */
+    subscribe(scripList: string[]): void;
+    unsubscribe(scripList: string[]): void;
+    subscribeOrderUpdate(): void;
+    unsubscribeOrderUpdate(): void;
+    disconnect(): void;
+}
+
+export { Shoonya };