feat: export types, fix timezone, enhance order interface, resolve security issues (#114)

Author: ranjanrak

CHANGELOG.md

@@ -1,5 +1,35 @@
 # Kite v5 - TypeScript
 
+## [5.1.0] - 2025-07-21
+
+### New Features
+
+- **Enhanced Type Safety**: Improved TypeScript type definitions for ticker event callbacks
+- **Comprehensive Type Exports**: All type definitions are now properly exported from main entry point with direct imports: `{ KiteConnect, Order, KiteTickerParams, Exchanges } from 'kiteconnect'`
+- **Ticker Event Types**: Added proper exports for `Tick`, `LTPTick`, `QuoteTick`, and `FullTick` interfaces
+- **Historical Data Types**: Added `HistoricalData` type with `Promise<HistoricalData[]>` for `getHistoricalData()` method
+- **Order Interface Completeness**: Enhanced Order interface with all missing fields from orderbook API response
+- **Enhanced Ticker Events**: Added `KiteTickerEvents` and `KiteTickerEventCallbacks` for type safety and discovery
+
+### Bug Fixes
+
+- **Security Vulnerabilities**: Fixed all npm audit vulnerabilities
+  - Upgraded axios from vulnerable version to 1.10.0 with proper TypeScript typing
+  - Applied security patches across all dependencies
+- **Timezone Handling**: Fixed historical data timezone handling for Date objects [Issue #107](https://github.com/zerodha/kiteconnectjs/issues/107)
+  - Date objects now correctly preserve local timezone instead of converting to UTC
+- **Missing Order Fields**: Added missing fields to Order interface including `instrument_token`, `placed_by`, `exchange_order_id`, and 15+ other fields [Issue #113](https://github.com/zerodha/kiteconnectjs/issues/113)
+- **Content-Type Detection**: Enhanced CSV and JSON content-type handling to support charset specifications using pattern matching instead of strict equality
+
+### Breaking Changes
+
+- **Date Object Timezone Handling**: If you were manually compensating for the timezone bug by adjusting Date objects, you'll need to update your code to use the actual intended time values
+
+### Backward Compatibility
+
+- String date inputs: No changes required
+- Ticker event callbacks: Existing `any[]` callbacks continue to work
+
 ## [5.0.0] - 2024-06-13
 
 ### Breaking Changes
@@ -35,4 +65,5 @@ If you are upgrading from a previous version, please review the following change
 
 - This release marks a significant update with the transition to TypeScript. Please report any issues or bugs to the repository's issue tracker.
 
-[5.0.0]: https://github.com/your-repo/kiteconnect-ts/releases/tag/v5.0.0
+[5.1.0]: https://github.com/zerodha/kiteconnectjs/releases/tag/v5.1.0
+[5.0.0]: https://github.com/zerodha/kiteconnectjs/releases/tag/v5.0.0

README.md

@@ -87,6 +87,7 @@ ticker.on("disconnect", onDisconnect);
 ticker.on("error", onError);
 ticker.on("close", onClose);
 ticker.on("order_update", onTrade);
+ticker.on("message", onMessage);
 
 function onTicks(ticks: any[]): void {
   console.log("Ticks", ticks);
@@ -113,6 +114,11 @@ function onClose(reason: string): void {
 function onTrade(order: any): void {
   console.log("Order update", order);
 }
+
+function onMessage(binaryData: ArrayBuffer): void {
+  console.log("Binary message received", binaryData);
+  // Process raw WebSocket binary data if needed
+}
 ```
 
 ## Auto re-connect WebSocket client

examples/kiteconnect.ts

@@ -24,6 +24,7 @@ async function init() {
         await getOHLC(['NSE:RELIANCE', 'NSE:SBIN', 'BSE:ONGC']);
         await getLTP(['NSE:RELIANCE', 'NSE:SBIN', 'BSE:ONGC']);
         await getHistoricalData(16320514, "day", "2024-05-11 00:00:00", "2024-06-12 00:00:00", true, true);
+        await getHistoricalData(16320514, "day", new Date('2024-05-11T09:15:00'), new Date('2024-06-12T15:30:00'), true, true);
         await placeRegularOrder();
         await placeIcebergOrder();
         await modifyRegularOrder(240611801793632);
@@ -176,7 +177,7 @@ async function getLTP(instruments: string[]) {
     }
 }
 
-async function getHistoricalData(instrumentToken: number, interval: string, from: string, to: string, continuous: boolean, oi: boolean) {
+async function getHistoricalData(instrumentToken: number, interval: string, from: string | Date, to: string | Date, continuous: boolean, oi: boolean) {
     try {
         const historicalData = await kc.getHistoricalData(instrumentToken, interval, from, to, continuous, oi);
         console.log('Historical Data:', historicalData);

examples/kiteticker.ts

@@ -1,4 +1,5 @@
 import { KiteTicker } from "kiteconnect";
+import { Tick, LTPTick, QuoteTick, FullTick } from "kiteconnect";
 
 const apiKey = 'your_api_key';
 const accessToken = 'generated_access_token';
@@ -15,11 +16,31 @@ ticker.on('disconnect', onDisconnect);
 ticker.on('error', onError);
 ticker.on('close', onClose);
 ticker.on('order_update', onTrade);
+ticker.on('message', onMessage);
 
+// OPTION 1: Backward compatible (existing code continues to work)
 function onTicks(ticks: any[]): void {
     console.log("Ticks", ticks);
 }
 
+// OPTION 2: Type-safe approach (recommended)
+function onTicks(ticks: Tick[]): void {
+    console.log("Ticks", ticks);
+    
+    // With typed approach:
+    ticks.forEach(tick => {
+        console.log('Instrument:', tick.instrument_token);
+        console.log('Last price:', tick.last_price);
+        console.log('Mode:', tick.mode);
+        
+        if (tick.mode === 'full') {
+            const fullTick = tick as FullTick;
+            console.log('Volume:', fullTick.volume_traded);
+            console.log('OI:', fullTick.oi);
+        }
+    });
+}
+
 function subscribe(): void {
     const tokens = [738561, 256265];
     ticker.subscribe(tokens);
@@ -41,3 +62,7 @@ function onClose(reason: string): void {
 function onTrade(order: any): void {
     console.log("Order update", order);
 }
+
+function onMessage(binaryData: ArrayBuffer): void {
+    console.log("Binary message received", binaryData);
+}

interfaces/connect.ts

@@ -276,21 +276,53 @@ export interface ConvertPositionParams {
  */
 export interface Order {
     /**
-     * @type {?TransactionTypes}
+     * @type {?string}
      */
-    transaction_type?: TransactionTypes;
+    placed_by?: string;
     /**
      * @type {?(string | number)}
      */
-    quantity?: string | number;
+    order_id?: string | number;
     /**
-     * @type {?Products}
+     * @type {?string}
      */
-    product?: Products;
+    exchange_order_id?: string;
     /**
-     * @type {?OrderTypes}
+     * @type {?(string | number)}
      */
-    order_type?: OrderTypes;
+    parent_order_id?: string | number;
+    /**
+     * @type {?string}
+     */
+    status?: string;
+    /**
+     * @type {?string}
+     */
+    status_message?: string;
+    /**
+     * @type {?string}
+     */
+    status_message_raw?: string;
+    /**
+     * @type {?(string | Date)}
+     */
+    order_timestamp?: string | Date;
+    /**
+     * @type {?(string | Date)}
+     */
+    exchange_update_timestamp?: string | Date;
+    /**
+     * @type {?(string | Date)}
+     */
+    exchange_timestamp?: string | Date;
+    /**
+     * @type {?Varieties}
+     */
+    variety?: Varieties;
+    /**
+     * @type {?boolean}
+     */
+    modified?: boolean;
     /**
      * @type {?Exchanges}
      */
@@ -300,9 +332,33 @@ export interface Order {
      */
     tradingsymbol?: string;
     /**
-     * @type {?Varieties}
+     * @type {?number}
      */
-    variety?: Varieties;
+    instrument_token?: number;
+    /**
+     * @type {?OrderTypes}
+     */
+    order_type?: OrderTypes;
+    /**
+     * @type {?TransactionTypes}
+     */
+    transaction_type?: TransactionTypes;
+    /**
+     * @type {?Validities}
+     */
+    validity?: Validities;
+    /**
+     * @type {?Products}
+     */
+    product?: Products;
+    /**
+     * @type {?(string | number)}
+     */
+    quantity?: string | number;
+    /**
+     * @type {?(string | number)}
+     */
+    disclosed_quantity?: string | number;
     /**
      * @type {?(number | string)}
      */
@@ -312,25 +368,43 @@ export interface Order {
      */
     trigger_price?: number;
     /**
-     * @type {?PositionTypes}
+     * @type {?number}
      */
-    position_type?: PositionTypes;
+    average_price?: number;
     /**
-     * @type {?Products}
+     * @type {?(string | number)}
      */
-    old_product?: Products;
+    filled_quantity?: string | number;
     /**
-     * @type {?Products}
+     * @type {?(string | number)}
      */
-    new_product?: Products;
+    pending_quantity?: string | number;
     /**
      * @type {?(string | number)}
      */
-    amount?: string | number;
+    cancelled_quantity?: string | number;
+    /**
+     * @type {?(string | number)}
+     */
+    market_protection?: string | number;
+    /**
+     * @type {?any}
+     */
+    meta?: any;
     /**
      * @type {?string}
      */
     tag?: string;
+    /**
+     * @type {?string}
+     */
+    guid?: string;
+    
+    // Additional fields for compatibility with other interfaces (MF SIP, GTT, etc.)
+    /**
+     * @type {?(string | number)}
+     */
+    amount?: string | number;
     /**
      * @type {?(string | number)}
      */
@@ -347,10 +421,6 @@ export interface Order {
      * @type {?(string | number)}
      */
     instalment_day?: string | number;
-    /**
-     * @type {?(string | number)}
-     */
-    status?: string | number;
     /**
      * @type {?(string | number)}
      */
@@ -372,17 +442,17 @@ export interface Order {
      */
     orders?: Order[];
     /**
-     * @type {?(string | number)}
+     * @type {?PositionTypes}
      */
-    order_id?: string | number;
+    position_type?: PositionTypes;
     /**
-     * @type {?(string | number)}
+     * @type {?Products}
      */
-    parent_order_id?: string | number;
+    old_product?: Products;
     /**
-     * @type {number}
+     * @type {?Products}
      */
-     average_price?: number;
+    new_product?: Products;
 }
 
 /**

interfaces/ticker.ts

@@ -136,3 +136,32 @@ export interface Depth {
 
 // Combined type for all tick modes
 export type Tick = LTPTick | QuoteTick | FullTick;
+
+/**
+ * Event types for KiteTicker
+ */
+export type KiteTickerEvents = 
+    | 'connect'
+    | 'ticks' 
+    | 'disconnect'
+    | 'error'
+    | 'close'
+    | 'reconnect'
+    | 'noreconnect'
+    | 'message'
+    | 'order_update';
+
+/**
+ * Event callback types for KiteTicker
+ */
+export interface KiteTickerEventCallbacks {
+    connect: () => void;
+    ticks: (ticks: Tick[]) => void;
+    disconnect: (error: Error) => void;
+    error: (error: Error) => void;
+    close: (reason: string) => void;
+    reconnect: (reconnect_count: number, reconnect_interval: number) => void;
+    noreconnect: () => void;
+    message: (binaryData: ArrayBuffer) => void;
+    order_update: (order: any) => void;
+}