@rnsk/toolkits 0.0.7 → 0.0.8

package/dist/toolkits/groww/tools/index.d.ts

@@ -0,0 +1,394 @@
+import { growwGetUserProfile } from './user.js';
+import { growwPlaceOrder, growwModifyOrder, growwCancelOrder, growwGetTradesForOrder, growwGetOrderStatus, growwGetOrderStatusByReferenceId, growwListOrders, growwGetOrderDetail } from './orders.js';
+import { growwCreateGttOrder, growwCreateOcoOrder, growwModifySmartOrder, growwCancelSmartOrder, growwGetSmartOrder, growwListSmartOrders } from './smart-orders.js';
+import { growwGetHoldings, growwGetPositions, growwGetPositionForSymbol } from './portfolio.js';
+import { growwGetUserMargin, growwGetRequiredMargin } from './margin.js';
+import { growwGetQuote, growwGetLtp, growwGetOhlc, growwGetOptionChain, growwGetGreeks } from './live-data.js';
+import { growwGetHistoricalCandles, growwGetHistoricalCandleRange, growwGetExpiries, growwGetContracts } from './historical.js';
+import { growwSearchInstruments } from './instruments.js';
+export { growwGetUserProfile, growwPlaceOrder, growwModifyOrder, growwCancelOrder, growwGetTradesForOrder, growwGetOrderStatus, growwGetOrderStatusByReferenceId, growwListOrders, growwGetOrderDetail, growwCreateGttOrder, growwCreateOcoOrder, growwModifySmartOrder, growwCancelSmartOrder, growwGetSmartOrder, growwListSmartOrders, growwGetHoldings, growwGetPositions, growwGetPositionForSymbol, growwGetUserMargin, growwGetRequiredMargin, growwGetQuote, growwGetLtp, growwGetOhlc, growwGetOptionChain, growwGetGreeks, growwGetHistoricalCandles, growwGetHistoricalCandleRange, growwGetExpiries, growwGetContracts, growwSearchInstruments, };
+export declare const growwTools: ({
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        growwAccessToken?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        product: string;
+        validity: string;
+        trading_symbol: string;
+        quantity: number;
+        exchange: string;
+        segment: string;
+        order_type: string;
+        transaction_type: string;
+        order_reference_id: string;
+        growwAccessToken?: string | undefined;
+        price?: number | undefined;
+        trigger_price?: number | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        segment: string;
+        order_type: string;
+        groww_order_id: string;
+        growwAccessToken?: string | undefined;
+        quantity?: number | undefined;
+        price?: number | undefined;
+        trigger_price?: number | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        segment: string;
+        groww_order_id: string;
+        growwAccessToken?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "delete";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        segment: string;
+        groww_order_id: string;
+        page?: number | undefined;
+        page_size?: number | undefined;
+        growwAccessToken?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        segment: string;
+        groww_order_id: string;
+        growwAccessToken?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        segment: string;
+        order_reference_id: string;
+        growwAccessToken?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        page?: number | undefined;
+        page_size?: number | undefined;
+        growwAccessToken?: string | undefined;
+        segment?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        duration: string;
+        trading_symbol: string;
+        quantity: number;
+        trigger_price: string;
+        exchange: string;
+        segment: string;
+        order_type: string;
+        transaction_type: string;
+        reference_id: string;
+        trigger_direction: string;
+        product_type: string;
+        growwAccessToken?: string | undefined;
+        price?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        duration: string;
+        trading_symbol: string;
+        quantity: number;
+        exchange: string;
+        segment: string;
+        transaction_type: string;
+        reference_id: string;
+        product_type: string;
+        net_position_quantity: number;
+        target_trigger_price: string;
+        target_order_type: string;
+        stop_loss_trigger_price: string;
+        stop_loss_order_type: string;
+        growwAccessToken?: string | undefined;
+        target_price?: string | undefined;
+        stop_loss_price?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        segment: string;
+        smart_order_id: string;
+        smart_order_type: string;
+        duration?: string | undefined;
+        growwAccessToken?: string | undefined;
+        quantity?: number | undefined;
+        trigger_price?: string | undefined;
+        order_type?: string | undefined;
+        trigger_direction?: string | undefined;
+        product_type?: string | undefined;
+        target_trigger_price?: string | undefined;
+        stop_loss_trigger_price?: string | undefined;
+        order_price?: string | undefined;
+        order_transaction_type?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        segment: string;
+        smart_order_id: string;
+        smart_order_type: string;
+        growwAccessToken?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "delete";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        segment: string;
+        smart_order_id: string;
+        smart_order_type: string;
+        growwAccessToken?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        status?: string | undefined;
+        page?: number | undefined;
+        page_size?: number | undefined;
+        growwAccessToken?: string | undefined;
+        segment?: string | undefined;
+        smart_order_type?: string | undefined;
+        start_date_time?: string | undefined;
+        end_date_time?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        growwAccessToken?: string | undefined;
+        segment?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        trading_symbol: string;
+        growwAccessToken?: string | undefined;
+        segment?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        segment: string;
+        orders: {
+            product: string;
+            trading_symbol: string;
+            quantity: number;
+            exchange: string;
+            segment: string;
+            order_type: string;
+            transaction_type: string;
+            price?: number | undefined;
+        }[];
+        growwAccessToken?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        trading_symbol: string;
+        exchange: string;
+        segment: string;
+        growwAccessToken?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        segment: string;
+        exchange_symbols: string;
+        growwAccessToken?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        exchange: string;
+        underlying: string;
+        expiry_date: string;
+        growwAccessToken?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        trading_symbol: string;
+        exchange: string;
+        underlying: string;
+        expiry: string;
+        growwAccessToken?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        exchange: string;
+        segment: string;
+        groww_symbol: string;
+        start_time: string;
+        end_time: string;
+        candle_interval: string;
+        growwAccessToken?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        trading_symbol: string;
+        exchange: string;
+        segment: string;
+        start_time: string;
+        end_time: string;
+        growwAccessToken?: string | undefined;
+        interval_in_minutes?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        exchange: string;
+        underlying_symbol: string;
+        year?: number | undefined;
+        month?: number | undefined;
+        growwAccessToken?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        exchange: string;
+        expiry_date: string;
+        underlying_symbol: string;
+        growwAccessToken?: string | undefined;
+    }, unknown>;
+    requiredAuth: "growwAccessToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        limit?: number | undefined;
+        trading_symbol?: string | undefined;
+        exchange?: string | undefined;
+        segment?: string | undefined;
+        groww_symbol?: string | undefined;
+        underlying_symbol?: string | undefined;
+        instrument_type?: string | undefined;
+        offset?: number | undefined;
+    }, {
+        error: string;
+        statusCode: number;
+        source?: undefined;
+        columns?: undefined;
+        returned?: undefined;
+        offset?: undefined;
+        instruments?: undefined;
+        note?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        statusCode?: undefined;
+        source?: undefined;
+        columns?: undefined;
+        returned?: undefined;
+        offset?: undefined;
+        instruments?: undefined;
+        note?: undefined;
+        message?: undefined;
+    } | {
+        source: string;
+        columns: string[];
+        returned: number;
+        offset: number;
+        instruments: Record<string, string>[];
+        note: string;
+        error?: undefined;
+        statusCode?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        statusCode?: undefined;
+        source?: undefined;
+        columns?: undefined;
+        returned?: undefined;
+        offset?: undefined;
+        instruments?: undefined;
+        note?: undefined;
+    }>;
+    scope: "read";
+    requiredAuth?: undefined;
+})[];
+//# sourceMappingURL=index.d.ts.map

package/dist/toolkits/groww/tools/index.js

@@ -0,0 +1,222 @@
+// @ts-nocheck
+import { growwGetUserProfile } from './user.js';
+import { growwPlaceOrder, growwModifyOrder, growwCancelOrder, growwGetTradesForOrder, growwGetOrderStatus, growwGetOrderStatusByReferenceId, growwListOrders, growwGetOrderDetail, } from './orders.js';
+import { growwCreateGttOrder, growwCreateOcoOrder, growwModifySmartOrder, growwCancelSmartOrder, growwGetSmartOrder, growwListSmartOrders, } from './smart-orders.js';
+import { growwGetHoldings, growwGetPositions, growwGetPositionForSymbol } from './portfolio.js';
+import { growwGetUserMargin, growwGetRequiredMargin } from './margin.js';
+import { growwGetQuote, growwGetLtp, growwGetOhlc, growwGetOptionChain, growwGetGreeks } from './live-data.js';
+import { growwGetHistoricalCandles, growwGetHistoricalCandleRange, growwGetExpiries, growwGetContracts, } from './historical.js';
+import { growwSearchInstruments } from './instruments.js';
+export { growwGetUserProfile, growwPlaceOrder, growwModifyOrder, growwCancelOrder, growwGetTradesForOrder, growwGetOrderStatus, growwGetOrderStatusByReferenceId, growwListOrders, growwGetOrderDetail, growwCreateGttOrder, growwCreateOcoOrder, growwModifySmartOrder, growwCancelSmartOrder, growwGetSmartOrder, growwListSmartOrders, growwGetHoldings, growwGetPositions, growwGetPositionForSymbol, growwGetUserMargin, growwGetRequiredMargin, growwGetQuote, growwGetLtp, growwGetOhlc, growwGetOptionChain, growwGetGreeks, growwGetHistoricalCandles, growwGetHistoricalCandleRange, growwGetExpiries, growwGetContracts, growwSearchInstruments, };
+export const growwTools = [
+    {
+        name: 'growwGetUserProfile',
+        description: 'Get Groww user profile including UCC, enabled exchanges, DDPI status and active segments.',
+        tool: growwGetUserProfile,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwPlaceOrder',
+        description: 'Place a new equity or F&O order on Groww.',
+        tool: growwPlaceOrder,
+        requiredAuth: 'growwAccessToken',
+        scope: 'write',
+    },
+    {
+        name: 'growwModifyOrder',
+        description: 'Modify a pending/open Groww order (quantity, price, trigger price, order type).',
+        tool: growwModifyOrder,
+        requiredAuth: 'growwAccessToken',
+        scope: 'write',
+    },
+    {
+        name: 'growwCancelOrder',
+        description: 'Cancel a pending/open Groww order.',
+        tool: growwCancelOrder,
+        requiredAuth: 'growwAccessToken',
+        scope: 'delete',
+    },
+    {
+        name: 'growwGetTradesForOrder',
+        description: 'Get all trades (fills) assigned to a Groww order ID.',
+        tool: growwGetTradesForOrder,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetOrderStatus',
+        description: 'Check status of a Groww order using its groww_order_id.',
+        tool: growwGetOrderStatus,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetOrderStatusByReferenceId',
+        description: 'Check status of a Groww order using your own order_reference_id.',
+        tool: growwGetOrderStatusByReferenceId,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwListOrders',
+        description: 'List today\u2019s Groww orders (open, pending and executed) with pagination.',
+        tool: growwListOrders,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetOrderDetail',
+        description: 'Get full details of a Groww order using its groww_order_id.',
+        tool: growwGetOrderDetail,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwCreateGttOrder',
+        description: 'Create a GTT (Good Till Triggered) smart order.',
+        tool: growwCreateGttOrder,
+        requiredAuth: 'growwAccessToken',
+        scope: 'write',
+    },
+    {
+        name: 'growwCreateOcoOrder',
+        description: 'Create an OCO (One Cancels Other) smart order with target and stop-loss legs.',
+        tool: growwCreateOcoOrder,
+        requiredAuth: 'growwAccessToken',
+        scope: 'write',
+    },
+    {
+        name: 'growwModifySmartOrder',
+        description: 'Modify an active GTT or OCO smart order.',
+        tool: growwModifySmartOrder,
+        requiredAuth: 'growwAccessToken',
+        scope: 'write',
+    },
+    {
+        name: 'growwCancelSmartOrder',
+        description: 'Cancel an active GTT or OCO smart order.',
+        tool: growwCancelSmartOrder,
+        requiredAuth: 'growwAccessToken',
+        scope: 'delete',
+    },
+    {
+        name: 'growwGetSmartOrder',
+        description: 'Get full details of a GTT or OCO smart order.',
+        tool: growwGetSmartOrder,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwListSmartOrders',
+        description: 'List smart orders filtered by segment, type, status and time window.',
+        tool: growwListSmartOrders,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetHoldings',
+        description: 'Get current DEMAT stock holdings.',
+        tool: growwGetHoldings,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetPositions',
+        description: 'Get all user positions with P&L.',
+        tool: growwGetPositions,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetPositionForSymbol',
+        description: 'Get user position for a particular trading symbol.',
+        tool: growwGetPositionForSymbol,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetUserMargin',
+        description: 'Get available user margin details.',
+        tool: growwGetUserMargin,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetRequiredMargin',
+        description: 'Calculate required margin for a single order or a basket of orders.',
+        tool: growwGetRequiredMargin,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetQuote',
+        description: 'Get full live snapshot for an instrument with depth, OHLC, volumes and OI.',
+        tool: growwGetQuote,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetLtp',
+        description: 'Get last traded price for up to 50 instruments.',
+        tool: growwGetLtp,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetOhlc',
+        description: 'Get real-time OHLC snapshot for up to 50 instruments.',
+        tool: growwGetOhlc,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetOptionChain',
+        description: 'Get full FNO option chain with Greeks, LTP, OI and volume.',
+        tool: growwGetOptionChain,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetGreeks',
+        description: 'Get Greeks for a single FNO contract.',
+        tool: growwGetGreeks,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetHistoricalCandles',
+        description: 'Get historical OHLCV candles (+OI for FNO) for backtesting using a Groww symbol.',
+        tool: growwGetHistoricalCandles,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetHistoricalCandleRange',
+        description: 'DEPRECATED by Groww. Get historical candles by trading symbol.',
+        tool: growwGetHistoricalCandleRange,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetExpiries',
+        description: 'List available FNO expiry dates for an underlying.',
+        tool: growwGetExpiries,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwGetContracts',
+        description: 'List Groww symbols of FNO contracts for an underlying and expiry.',
+        tool: growwGetContracts,
+        requiredAuth: 'growwAccessToken',
+        scope: 'read',
+    },
+    {
+        name: 'growwSearchInstruments',
+        description: 'Search the Groww instruments master (no auth needed) to resolve trading and Groww symbols.',
+        tool: growwSearchInstruments,
+        scope: 'read',
+    },
+];
+//# sourceMappingURL=index.js.map

package/dist/toolkits/groww/tools/instruments.d.ts

@@ -0,0 +1,51 @@
+export declare const growwSearchInstruments: import("ai").Tool<{
+    limit?: number | undefined;
+    trading_symbol?: string | undefined;
+    exchange?: string | undefined;
+    segment?: string | undefined;
+    groww_symbol?: string | undefined;
+    underlying_symbol?: string | undefined;
+    instrument_type?: string | undefined;
+    offset?: number | undefined;
+}, {
+    error: string;
+    statusCode: number;
+    source?: undefined;
+    columns?: undefined;
+    returned?: undefined;
+    offset?: undefined;
+    instruments?: undefined;
+    note?: undefined;
+    message?: undefined;
+} | {
+    error: string;
+    statusCode?: undefined;
+    source?: undefined;
+    columns?: undefined;
+    returned?: undefined;
+    offset?: undefined;
+    instruments?: undefined;
+    note?: undefined;
+    message?: undefined;
+} | {
+    source: string;
+    columns: string[];
+    returned: number;
+    offset: number;
+    instruments: Record<string, string>[];
+    note: string;
+    error?: undefined;
+    statusCode?: undefined;
+    message?: undefined;
+} | {
+    error: string;
+    message: string;
+    statusCode?: undefined;
+    source?: undefined;
+    columns?: undefined;
+    returned?: undefined;
+    offset?: undefined;
+    instruments?: undefined;
+    note?: undefined;
+}>;
+//# sourceMappingURL=instruments.d.ts.map