@pungoyal/kite-cli 0.1.1 → 0.2.1

package/dist/context.js

@@ -1,17 +1,23 @@
 import { KiteApi } from './core/api.js';
 import { KiteClient } from './core/client.js';
-import { endpointsFor, loadConfig, resolveEnv, SANDBOX_CREDENTIALS, } from './core/config.js';
+import { endpointsFor, loadConfig, SANDBOX_CREDENTIALS, } from './core/config.js';
 import { getSecret } from './core/credentials.js';
 import { AuthRequiredError, ExitCode, KiteCliError } from './core/errors.js';
 import { InstrumentStore } from './core/instruments.js';
+import { resolveProfile, resolveTradingConfig, storagePrefixFor } from './core/profiles.js';
 import { RateLimiter } from './core/ratelimit.js';
 import { registerSecret } from './core/redact.js';
 import { isExpired, loadSessionMeta } from './core/session.js';
 import { Io } from './output/io.js';
 export async function createContext(options, signal, streams) {
-    const config = await loadConfig();
-    const env = resolveEnv(options.env, config);
+    const loaded = await loadConfig();
+    const profile = resolveProfile({ profileFlag: options.profile, envFlag: options.env }, loaded);
+    const env = profile.env;
     const endpoints = endpointsFor(env);
+    const credentialScope = storagePrefixFor(profile);
+    // The trading config actually in force: global settings overlaid with this
+    // profile's overrides (fail-closed — an omitted cap inherits the global one).
+    const config = { ...loaded, trading: resolveTradingConfig(loaded, profile) };
     const io = new Io({
         json: options.json ?? false,
         color: options.color ?? config.output.color,
@@ -21,9 +27,17 @@ export async function createContext(options, signal, streams) {
         // process streams regardless of what the caller asked for.
         ...(streams ? { streams } : {}),
     });
-    const apiKey = resolveApiKey(config, env);
-    const session = await loadSessionMeta();
-    const accessToken = await resolveAccessToken(env, session, apiKey, io);
+    // Fail closed on an ambiguous account. When the caller named a profile
+    // explicitly, an ambient KITE_ACCESS_TOKEN / KITE_API_SECRET meant for some
+    // other account must not silently stand in for it — that is the wrong-account
+    // footgun this feature exists to prevent. The CI escape hatch is preserved
+    // for the default / configured profile, which is not "explicit".
+    if (profile.explicit && (process.env['KITE_ACCESS_TOKEN'] || process.env['KITE_API_SECRET'])) {
+        throw new KiteCliError(`Profile "${profile.name}" was named explicitly, but KITE_ACCESS_TOKEN or KITE_API_SECRET is set in the environment and would override it.`, ExitCode.Usage, "Unset those variables to use the profile's own stored credentials, or drop --profile/KITE_PROFILE to use the environment ones.");
+    }
+    const apiKey = resolveApiKey(profile);
+    const session = await loadSessionMeta(profile.name);
+    const accessToken = await resolveAccessToken(env, session, apiKey, io, credentialScope);
     const client = new KiteClient({
         apiKey,
         accessToken,
@@ -36,7 +50,10 @@ export async function createContext(options, signal, streams) {
     const instruments = new InstrumentStore(api, env);
     const requireSession = () => {
         if (!client.hasSession()) {
-            throw new AuthRequiredError(env === 'sandbox' ? 'No sandbox session. Run `kite login --env sandbox`.' : 'Not logged in.');
+            if (profile.name !== 'default') {
+                throw new AuthRequiredError(`Not logged in to profile "${profile.name}".`, `Run \`kite --profile ${profile.name} login\`.`);
+            }
+            throw new AuthRequiredError(env === 'sandbox' ? 'No sandbox session.' : 'Not logged in.', env === 'sandbox' ? 'Run `kite login --env sandbox`.' : 'Run `kite login` to start a session.');
         }
         // A session file is absent when credentials came from the environment,
         // which is the normal CI path — synthesise a minimal record.
@@ -45,6 +62,7 @@ export async function createContext(options, signal, streams) {
                 userId: 'unknown',
                 env,
                 apiKey,
+                profile: profile.name,
                 expiresAt: new Date(Date.now() + 3_600_000).toISOString(),
                 exchanges: [],
                 products: [],
@@ -55,7 +73,7 @@ export async function createContext(options, signal, streams) {
     const requireApiSecret = async () => {
         if (env === 'sandbox')
             return SANDBOX_CREDENTIALS.apiSecret;
-        const found = await getSecret('api_secret', { env });
+        const found = await getSecret('api_secret', { scope: credentialScope });
         if (!found) {
             throw new KiteCliError('No API secret is stored.', ExitCode.Auth, 'Run `kite login` and paste your API secret when prompted, or set KITE_API_SECRET.');
         }
@@ -65,6 +83,8 @@ export async function createContext(options, signal, streams) {
         io,
         config,
         env,
+        profile,
+        credentialScope,
         endpoints,
         client,
         api,
@@ -76,22 +96,20 @@ export async function createContext(options, signal, streams) {
         requireApiSecret,
     };
 }
-function resolveApiKey(config, env) {
+function resolveApiKey(profile) {
     const fromEnv = process.env['KITE_API_KEY'];
     if (fromEnv && fromEnv.trim() !== '')
         return fromEnv;
-    if (env === 'sandbox')
-        return SANDBOX_CREDENTIALS.apiKey;
-    if (config.apiKey)
-        return config.apiKey;
-    // Deliberately not fatal here: `kite login` sets this up, and `kite config`
-    // must remain usable before it exists.
-    return '';
+    // The profile already carries the right key: the sandbox constant, the
+    // default profile's config.apiKey, or a named profile's stored key. Empty is
+    // fine and non-fatal — `kite login` sets it up, and `kite config` must work
+    // before it exists.
+    return profile.apiKey;
 }
-async function resolveAccessToken(env, session, apiKey, io) {
+async function resolveAccessToken(env, session, apiKey, io, scope) {
     let found;
     try {
-        found = await getSecret('access_token', { env });
+        found = await getSecret('access_token', { scope });
     }
     catch (err) {
         // A corrupt or wrong-passphrase credential file must not brick the CLI.

package/dist/core/api.d.ts

@@ -61,15 +61,15 @@ export declare class KiteApi {
     }): Promise<{
         [x: string]: unknown;
         user_id: string;
-        exchanges: string[];
-        products: string[];
-        order_types: string[];
-        access_token: string;
         user_name?: string | undefined;
         user_shortname?: string | undefined;
         email?: string | undefined;
         user_type?: string | undefined;
         broker?: string | undefined;
+        exchanges: string[];
+        products: string[];
+        order_types: string[];
+        access_token: string;
         public_token?: string | undefined;
         refresh_token?: string | undefined;
         login_time?: string | undefined;
@@ -78,14 +78,14 @@ export declare class KiteApi {
     getProfile(signal?: AbortSignal): Promise<{
         [x: string]: unknown;
         user_id: string;
-        exchanges: string[];
-        products: string[];
-        order_types: string[];
         user_name?: string | undefined;
         user_shortname?: string | undefined;
         email?: string | undefined;
         user_type?: string | undefined;
         broker?: string | undefined;
+        exchanges: string[];
+        products: string[];
+        order_types: string[];
     }>;
     getMargins(signal?: AbortSignal): Promise<{
         [x: string]: unknown;
@@ -151,9 +151,9 @@ export declare class KiteApi {
     getOrders(signal?: AbortSignal): Promise<{
         [x: string]: unknown;
         order_id: string;
-        status: string;
         parent_order_id?: string | null | undefined;
         exchange_order_id?: string | null | undefined;
+        status: string;
         status_message?: string | null | undefined;
         status_message_raw?: string | null | undefined;
         order_timestamp?: string | null | undefined;
@@ -184,9 +184,9 @@ export declare class KiteApi {
     getOrderHistory(orderId: string, signal?: AbortSignal): Promise<{
         [x: string]: unknown;
         order_id: string;
-        status: string;
         parent_order_id?: string | null | undefined;
         exchange_order_id?: string | null | undefined;
+        status: string;
         status_message?: string | null | undefined;
         status_message_raw?: string | null | undefined;
         order_timestamp?: string | null | undefined;
@@ -252,10 +252,7 @@ export declare class KiteApi {
      * the network level the caller must reconcile via `findOrderByTag`, because
      * a timed-out request may still have been executed.
      */
-    placeOrder(params: PlaceOrderParams, signal?: AbortSignal): Promise<{
-        [x: string]: unknown;
-        order_id: string;
-    } | ({
+    placeOrder(params: PlaceOrderParams, signal?: AbortSignal): Promise<({
         [x: string]: unknown;
         order_id: string;
     } | {
@@ -266,7 +263,10 @@ export declare class KiteApi {
             error_type?: string | undefined;
             message?: string | undefined;
         };
-    })[]>;
+    })[] | {
+        [x: string]: unknown;
+        order_id: string;
+    }>;
     modifyOrder(params: ModifyOrderParams, signal?: AbortSignal): Promise<{
         [x: string]: unknown;
         order_id: string;
@@ -290,9 +290,9 @@ export declare class KiteApi {
     findOrderByTag(tag: string, signal?: AbortSignal): Promise<{
         [x: string]: unknown;
         order_id: string;
-        status: string;
         parent_order_id?: string | null | undefined;
         exchange_order_id?: string | null | undefined;
+        status: string;
         status_message?: string | null | undefined;
         status_message_raw?: string | null | undefined;
         order_timestamp?: string | null | undefined;
@@ -322,7 +322,12 @@ export declare class KiteApi {
     getGtts(signal?: AbortSignal): Promise<{
         [x: string]: unknown;
         id: number;
+        user_id?: string | undefined;
+        parent_trigger?: unknown;
         type: string;
+        created_at?: string | undefined;
+        updated_at?: string | undefined;
+        expires_at?: string | undefined;
         status: string;
         condition: {
             [x: string]: unknown;
@@ -343,16 +348,16 @@ export declare class KiteApi {
             price?: number | undefined;
             result?: unknown;
         }[];
-        user_id?: string | undefined;
-        parent_trigger?: unknown;
-        created_at?: string | undefined;
-        updated_at?: string | undefined;
-        expires_at?: string | undefined;
     }[]>;
     getGtt(id: number, signal?: AbortSignal): Promise<{
         [x: string]: unknown;
         id: number;
+        user_id?: string | undefined;
+        parent_trigger?: unknown;
         type: string;
+        created_at?: string | undefined;
+        updated_at?: string | undefined;
+        expires_at?: string | undefined;
         status: string;
         condition: {
             [x: string]: unknown;
@@ -373,11 +378,6 @@ export declare class KiteApi {
             price?: number | undefined;
             result?: unknown;
         }[];
-        user_id?: string | undefined;
-        parent_trigger?: unknown;
-        created_at?: string | undefined;
-        updated_at?: string | undefined;
-        expires_at?: string | undefined;
     }>;
     placeGtt(params: GttParams, signal?: AbortSignal): Promise<{
         [x: string]: unknown;
@@ -391,10 +391,182 @@ export declare class KiteApi {
         [x: string]: unknown;
         trigger_id: number;
     }>;
+    getAlerts(signal?: AbortSignal): Promise<{
+        [x: string]: unknown;
+        uuid: string;
+        user_id?: string | undefined;
+        type: string;
+        name?: string | undefined;
+        status: string;
+        disabled_reason?: string | undefined;
+        lhs_attribute?: string | undefined;
+        lhs_exchange?: string | undefined;
+        lhs_tradingsymbol?: string | undefined;
+        operator?: string | undefined;
+        rhs_type?: string | undefined;
+        rhs_attribute?: string | undefined;
+        rhs_exchange?: string | undefined;
+        rhs_tradingsymbol?: string | undefined;
+        rhs_constant?: number | undefined;
+        alert_count?: number | undefined;
+        basket?: {
+            [x: string]: unknown;
+            name?: string | undefined;
+            type?: string | undefined;
+            tags?: unknown[] | undefined;
+            items: {
+                [x: string]: unknown;
+                type?: string | undefined;
+                tradingsymbol?: string | undefined;
+                exchange?: string | undefined;
+                instrument_token?: number | undefined;
+                weight?: number | undefined;
+                params?: {
+                    [x: string]: unknown;
+                } | undefined;
+            }[];
+        } | undefined;
+        created_at?: string | undefined;
+        updated_at?: string | undefined;
+    }[]>;
+    getAlert(uuid: string, signal?: AbortSignal): Promise<{
+        [x: string]: unknown;
+        uuid: string;
+        user_id?: string | undefined;
+        type: string;
+        name?: string | undefined;
+        status: string;
+        disabled_reason?: string | undefined;
+        lhs_attribute?: string | undefined;
+        lhs_exchange?: string | undefined;
+        lhs_tradingsymbol?: string | undefined;
+        operator?: string | undefined;
+        rhs_type?: string | undefined;
+        rhs_attribute?: string | undefined;
+        rhs_exchange?: string | undefined;
+        rhs_tradingsymbol?: string | undefined;
+        rhs_constant?: number | undefined;
+        alert_count?: number | undefined;
+        basket?: {
+            [x: string]: unknown;
+            name?: string | undefined;
+            type?: string | undefined;
+            tags?: unknown[] | undefined;
+            items: {
+                [x: string]: unknown;
+                type?: string | undefined;
+                tradingsymbol?: string | undefined;
+                exchange?: string | undefined;
+                instrument_token?: number | undefined;
+                weight?: number | undefined;
+                params?: {
+                    [x: string]: unknown;
+                } | undefined;
+            }[];
+        } | undefined;
+        created_at?: string | undefined;
+        updated_at?: string | undefined;
+    }>;
+    getAlertHistory(uuid: string, signal?: AbortSignal): Promise<{
+        [x: string]: unknown;
+        uuid?: string | undefined;
+        type?: string | undefined;
+        condition?: string | undefined;
+        created_at?: string | undefined;
+        meta?: unknown;
+        order_meta?: unknown;
+    }[]>;
+    createAlert(params: AlertParams, signal?: AbortSignal): Promise<{
+        [x: string]: unknown;
+        uuid: string;
+        user_id?: string | undefined;
+        type: string;
+        name?: string | undefined;
+        status: string;
+        disabled_reason?: string | undefined;
+        lhs_attribute?: string | undefined;
+        lhs_exchange?: string | undefined;
+        lhs_tradingsymbol?: string | undefined;
+        operator?: string | undefined;
+        rhs_type?: string | undefined;
+        rhs_attribute?: string | undefined;
+        rhs_exchange?: string | undefined;
+        rhs_tradingsymbol?: string | undefined;
+        rhs_constant?: number | undefined;
+        alert_count?: number | undefined;
+        basket?: {
+            [x: string]: unknown;
+            name?: string | undefined;
+            type?: string | undefined;
+            tags?: unknown[] | undefined;
+            items: {
+                [x: string]: unknown;
+                type?: string | undefined;
+                tradingsymbol?: string | undefined;
+                exchange?: string | undefined;
+                instrument_token?: number | undefined;
+                weight?: number | undefined;
+                params?: {
+                    [x: string]: unknown;
+                } | undefined;
+            }[];
+        } | undefined;
+        created_at?: string | undefined;
+        updated_at?: string | undefined;
+    }>;
+    modifyAlert(uuid: string, params: AlertParams, signal?: AbortSignal): Promise<{
+        [x: string]: unknown;
+        uuid: string;
+        user_id?: string | undefined;
+        type: string;
+        name?: string | undefined;
+        status: string;
+        disabled_reason?: string | undefined;
+        lhs_attribute?: string | undefined;
+        lhs_exchange?: string | undefined;
+        lhs_tradingsymbol?: string | undefined;
+        operator?: string | undefined;
+        rhs_type?: string | undefined;
+        rhs_attribute?: string | undefined;
+        rhs_exchange?: string | undefined;
+        rhs_tradingsymbol?: string | undefined;
+        rhs_constant?: number | undefined;
+        alert_count?: number | undefined;
+        basket?: {
+            [x: string]: unknown;
+            name?: string | undefined;
+            type?: string | undefined;
+            tags?: unknown[] | undefined;
+            items: {
+                [x: string]: unknown;
+                type?: string | undefined;
+                tradingsymbol?: string | undefined;
+                exchange?: string | undefined;
+                instrument_token?: number | undefined;
+                weight?: number | undefined;
+                params?: {
+                    [x: string]: unknown;
+                } | undefined;
+            }[];
+        } | undefined;
+        created_at?: string | undefined;
+        updated_at?: string | undefined;
+    }>;
+    /**
+     * Delete one or more alerts.
+     *
+     * Kite takes the uuids as *repeated query parameters* (`?uuid=a&uuid=b`) on a
+     * DELETE, not a path segment or a form body — an easy thing to carry over
+     * wrongly from the GTT delete, which is path-keyed by a numeric id.
+     */
+    deleteAlerts(uuids: string[], signal?: AbortSignal): Promise<unknown>;
     getHoldings(signal?: AbortSignal): Promise<{
         [x: string]: unknown;
         tradingsymbol: string;
         exchange: string;
+        instrument_token?: number | undefined;
+        isin?: string | undefined;
+        product?: string | undefined;
         quantity: number;
         t1_quantity: number;
         realised_quantity: number;
@@ -407,9 +579,6 @@ export declare class KiteApi {
         pnl: number;
         day_change: number;
         day_change_percentage: number;
-        instrument_token?: number | undefined;
-        isin?: string | undefined;
-        product?: string | undefined;
     }[]>;
     getPositions(signal?: AbortSignal): Promise<{
         [x: string]: unknown;
@@ -417,6 +586,8 @@ export declare class KiteApi {
             [x: string]: unknown;
             tradingsymbol: string;
             exchange: string;
+            instrument_token?: number | undefined;
+            product?: string | undefined;
             quantity: number;
             overnight_quantity: number;
             multiplier: number;
@@ -436,13 +607,13 @@ export declare class KiteApi {
             sell_value: number;
             day_buy_quantity: number;
             day_sell_quantity: number;
-            instrument_token?: number | undefined;
-            product?: string | undefined;
         }[];
         day: {
             [x: string]: unknown;
             tradingsymbol: string;
             exchange: string;
+            instrument_token?: number | undefined;
+            product?: string | undefined;
             quantity: number;
             overnight_quantity: number;
             multiplier: number;
@@ -462,8 +633,6 @@ export declare class KiteApi {
             sell_value: number;
             day_buy_quantity: number;
             day_sell_quantity: number;
-            instrument_token?: number | undefined;
-            product?: string | undefined;
         }[];
     }>;
     getAuctions(signal?: AbortSignal): Promise<{
@@ -506,9 +675,9 @@ export declare class KiteApi {
     getQuote(instruments: string[], signal?: AbortSignal): Promise<Record<string, {
         [x: string]: unknown;
         instrument_token: number;
-        last_price: number;
         timestamp?: string | null | undefined;
         last_trade_time?: string | null | undefined;
+        last_price: number;
         last_quantity?: number | undefined;
         buy_quantity?: number | undefined;
         sell_quantity?: number | undefined;
@@ -616,7 +785,7 @@ export declare class KiteApi {
     }[]>;
     basketMargins(orders: unknown[], considerPositions?: boolean, signal?: AbortSignal): Promise<{
         [x: string]: unknown;
-        orders: {
+        initial?: {
             [x: string]: unknown;
             type?: string | undefined;
             tradingsymbol?: string | undefined;
@@ -652,8 +821,8 @@ export declare class KiteApi {
                 realised?: number | undefined;
                 unrealised?: number | undefined;
             } | undefined;
-        }[];
-        initial?: {
+        } | undefined;
+        final?: {
             [x: string]: unknown;
             type?: string | undefined;
             tradingsymbol?: string | undefined;
@@ -690,7 +859,7 @@ export declare class KiteApi {
                 unrealised?: number | undefined;
             } | undefined;
         } | undefined;
-        final?: {
+        orders: {
             [x: string]: unknown;
             type?: string | undefined;
             tradingsymbol?: string | undefined;
@@ -726,7 +895,7 @@ export declare class KiteApi {
                 realised?: number | undefined;
                 unrealised?: number | undefined;
             } | undefined;
-        } | undefined;
+        }[];
         charges?: unknown;
     }>;
     orderCharges(orders: unknown[], signal?: AbortSignal): Promise<{
@@ -768,14 +937,14 @@ export declare class KiteApi {
     }[]>;
     getMfHoldings(signal?: AbortSignal): Promise<{
         [x: string]: unknown;
+        folio?: string | null | undefined;
+        fund?: string | undefined;
         tradingsymbol: string;
         average_price: number;
         last_price: number;
+        last_price_date?: string | undefined;
         pnl: number;
         quantity: number;
-        folio?: string | null | undefined;
-        fund?: string | undefined;
-        last_price_date?: string | undefined;
     }[]>;
     /** Note: only returns the last 7 days of orders. */
     getMfOrders(signal?: AbortSignal): Promise<{
@@ -822,7 +991,45 @@ export interface GttParams {
         price: number;
     }>;
 }
-export declare const HISTORICAL_INTERVALS: readonly ["minute", "3minute", "5minute", "10minute", "15minute", "30minute", "60minute", "day"];
+export declare const ALERT_TYPES: readonly ['simple', 'ato'];
+export type AlertType = (typeof ALERT_TYPES)[number];
+/** Kite's raw comparison operators. The CLI accepts friendlier aliases and
+ * normalises to these before they reach the wire. */
+export declare const ALERT_OPERATORS: readonly ['<=', '>=', '<', '>', '=='];
+export type AlertOperator = (typeof ALERT_OPERATORS)[number];
+export declare const ALERT_RHS_TYPES: readonly ['constant', 'instrument'];
+export type AlertRhsType = (typeof ALERT_RHS_TYPES)[number];
+/** The only left/right attribute Kite documents for alerts. */
+export declare const ALERT_DEFAULT_ATTRIBUTE = "LastTradedPrice";
+export interface AlertBasketItem {
+    type: 'insert';
+    tradingsymbol: string;
+    exchange: string;
+    weight: number;
+    params: Record<string, unknown>;
+}
+export interface AlertBasket {
+    name: string;
+    type: string;
+    tags: string[];
+    items: AlertBasketItem[];
+}
+export interface AlertParams {
+    name: string;
+    type: AlertType;
+    lhs_exchange: string;
+    lhs_tradingsymbol: string;
+    lhs_attribute: string;
+    operator: AlertOperator;
+    rhs_type: AlertRhsType;
+    rhs_constant?: number | undefined;
+    rhs_exchange?: string | undefined;
+    rhs_tradingsymbol?: string | undefined;
+    rhs_attribute?: string | undefined;
+    /** Present only for `ato` alerts; placed as an order when the alert fires. */
+    basket?: AlertBasket | undefined;
+}
+export declare const HISTORICAL_INTERVALS: readonly ['minute', '3minute', '5minute', '10minute', '15minute', '30minute', '60minute', 'day'];
 export type HistoricalInterval = (typeof HISTORICAL_INTERVALS)[number];
 /**
  * Maximum date range per request, by interval.