nsekit 0.1.0

package/dist/websocket/ws-manager.d.ts

@@ -0,0 +1,101 @@
+/**
+ * WSManager — Coordinates WebSocket connections across multiple brokers.
+ *
+ * Provides a single subscription interface that fans out to the appropriate
+ * broker's tick stream based on token resolution via InstrumentMaster.
+ *
+ * Features:
+ *  - Multi-broker tick aggregation
+ *  - Token resolution via InstrumentMaster
+ *  - Auto-reconnect tracking
+ *  - Clean subscription lifecycle
+ */
+import type { BrokerId, WSConnectionState } from '../types/common';
+import type { TickCallback } from '../types/broker';
+import type { IBroker } from '../interfaces/broker.interface';
+import type { InstrumentMaster } from '../instruments/instrument-master';
+export interface WSRedisClient {
+    publish(channel: string, message: string): Promise<number>;
+    set(key: string, value: string, ...args: (string | number)[]): Promise<unknown>;
+}
+interface AggregatedState {
+    brokers: Record<string, WSConnectionState>;
+    totalSubscriptions: number;
+    totalSymbols: number;
+}
+export interface WSManagerOptions {
+    /** Optional Redis client for tick publishing. */
+    redis?: WSRedisClient;
+}
+export declare class WSManager {
+    private brokers;
+    private subscriptions;
+    private instrumentMaster;
+    private readonly redis;
+    constructor(options?: WSManagerOptions);
+    /**
+     * Optionally provide an InstrumentMaster for symbol-to-token resolution.
+     * Without it, symbols are passed directly to brokers as tokens.
+     */
+    setInstrumentMaster(master: InstrumentMaster): void;
+    /**
+     * Register a broker for WebSocket tick management.
+     */
+    addBroker(brokerId: BrokerId, broker: IBroker): void;
+    /**
+     * Remove a broker and clean up its subscriptions.
+     */
+    removeBroker(brokerId: BrokerId): void;
+    /**
+     * Subscribe to tick data for the given symbols.
+     *
+     * Symbols can be in the format `{exchange}:{tradingSymbol}` (e.g. "NSE:RELIANCE")
+     * or just a trading symbol. The manager resolves the appropriate broker tokens
+     * using InstrumentMaster when available.
+     *
+     * @returns The subscription ID for later unsubscription
+     */
+    subscribe(symbols: string[], callback: TickCallback): string;
+    /**
+     * Remove a subscription and clean up broker-level subscriptions.
+     */
+    unsubscribe(subId: string): void;
+    /**
+     * Unsubscribe all active subscriptions and clean up.
+     */
+    unsubscribeAll(): void;
+    /**
+     * Get an aggregated view of all broker connection states.
+     */
+    getState(): AggregatedState;
+    /**
+     * Get the connection state for a specific broker.
+     */
+    getBrokerState(brokerId: BrokerId): WSConnectionState;
+    /**
+     * Get reconnect statistics for a broker.
+     */
+    getReconnectInfo(brokerId: BrokerId): {
+        count: number;
+        lastAt: number | null;
+    } | undefined;
+    /**
+     * Record a reconnect event for tracking purposes.
+     * Call this from an external health monitor or broker event handler.
+     */
+    recordReconnect(brokerId: BrokerId): void;
+    /** List all registered broker IDs. */
+    getBrokerIds(): BrokerId[];
+    /** Number of active subscriptions. */
+    get subscriptionCount(): number;
+    /**
+     * Resolve an array of symbols into per-broker token groups.
+     *
+     * If InstrumentMaster is available, look up each symbol to find which
+     * brokers have a token for it and what that token is. Otherwise, send
+     * the raw symbols to all registered brokers.
+     */
+    private resolveSymbolsToBrokers;
+}
+export {};
+//# sourceMappingURL=ws-manager.d.ts.map

package/dist/websocket/ws-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-manager.d.ts","sourceRoot":"","sources":["../../src/websocket/ws-manager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,KAAK,EAAe,YAAY,EAAgB,MAAM,iBAAiB,CAAC;AAC/E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAIzE,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3D,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACjF;AAmBD,UAAU,eAAe;IACvB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC3C,kBAAkB,EAAE,MAAM,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;CACtB;AAaD,MAAM,WAAW,gBAAgB;IAC/B,iDAAiD;IACjD,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB;AAED,qBAAa,SAAS;IACpB,OAAO,CAAC,OAAO,CAAyC;IACxD,OAAO,CAAC,aAAa,CAA0C;IAC/D,OAAO,CAAC,gBAAgB,CAAiC;IACzD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAuB;gBAEjC,OAAO,CAAC,EAAE,gBAAgB;IAItC;;;OAGG;IACH,mBAAmB,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI;IAMnD;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAG,IAAI;IAapD;;OAEG;IACH,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;IAkBtC;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,YAAY,GAAG,MAAM;IA0C5D;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAchC;;OAEG;IACH,cAAc,IAAI,IAAI;IAQtB;;OAEG;IACH,QAAQ,IAAI,eAAe;IAqB3B;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,iBAAiB;IAMrD;;OAEG;IACH,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,SAAS;IAS1F;;;OAGG;IACH,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;IASzC,sCAAsC;IACtC,YAAY,IAAI,QAAQ,EAAE;IAI1B,sCAAsC;IACtC,IAAI,iBAAiB,IAAI,MAAM,CAE9B;IAID;;;;;;OAMG;IACH,OAAO,CAAC,uBAAuB;CAiDhC"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "nsekit",
+  "version": "0.1.0",
+  "description": "Unified broker abstraction for Indian stock markets - CCXT-like interface for NSE/BSE brokers",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "package.json",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "bun run clean && bun run build:types && bun run build:js",
+    "build:types": "bunx tsc --emitDeclarationOnly --declaration --declarationMap --outDir dist",
+    "build:js": "bun build src/index.ts --outdir dist --target bun --format esm",
+    "dev": "bun --watch src/index.ts",
+    "test": "bun test",
+    "test:manual": "bun run test-manual.ts",
+    "lint": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "bun run build"
+  },
+  "dependencies": {
+    "kiteconnect": "^5.0.0",
+    "ws": "^8.16.0",
+    "ioredis": "^5.3.2",
+    "zod": "^3.22.4",
+    "date-fns": "^3.3.1",
+    "otplib": "^12.0.1",
+    "pino": "^8.17.2"
+  },
+  "devDependencies": {
+    "@types/ws": "^8.5.10",
+    "typescript": "^5.3.3",
+    "bun-types": "latest"
+  },
+  "keywords": ["nse", "bse", "trading", "broker", "zerodha", "finvasia", "dhan", "options"],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ilampirai/nsekit.git"
+  }
+}