@tigeropenapi/tigeropen 0.5.4 → 0.5.5

package/dist/types/quote/quote-client.d.ts

@@ -9,7 +9,7 @@ import { HttpClient } from '../client/http-client';
 import type { ClientConfig } from '../config/client-config';
 import type { TokenManager } from '../config/token-manager';
 import type { MarketState, Brief, Kline, KlineItem, Timeline, TradeTick, Depth, OptionExpiration, OptionChain, OptionChainFilter, FutureExchange, FutureContractInfo, FutureQuote, FutureKline, FutureKlineItem, FinancialDailyItem, FinancialReportItem, CorporateAction, CorporateSymbolChange, CorporateDelisting, CorporateIPO, CapitalFlow, CapitalDistribution, ScannerResult, QuotePermission, MarketScannerRequest, SymbolName, TradeMeta, StockDetail, StockBroker, StockIndustry, TradeRankItem, ShortInterest, KlineQuota, OptionAnalysis, OptionSymbol, FutureMainContractHistory, FutureTradingTime, FutureTradeTickItem, FutureDepth, WarrantBrief, WarrantFilterResult, IndustryItem, IndustryStock, TradingCalendarItem, ExchangeRate, FinancialCurrency, QuoteOvernight, MarketScannerTagGroup, FundContractInfo, FundQuote, FundHistoryQuote, FinancialDailyRequest, FinancialReportRequest, CorporateActionRequest } from '../model/quote';
-import type { BriefRequest, DepthQuoteRequest, TradeTickRequest, FutureBriefRequest, SymbolsRequest, TradeMetasRequest, StockDetailsRequest, StockDelayBriefsRequest, KlineRequest, KlineByPageRequest, TimelineHistoryRequest, TradeRankRequest, ShortInterestRequest, StockBrokerRequest, StockFundamentalRequest, StockIndustryRequest, KlineQuotaRequest, QuotePermissionRequest, OptionTradeTicksRequest, OptionTimelineRequest, OptionDepthRequest, OptionSymbolsRequest, OptionAnalysisRequest, FutureContractSingleRequest, AllFutureContractsRequest, FutureContinuousContractsRequest, FutureHistoryMainContractRequest, FutureKlineRequest, FutureKlineByPageRequest, FutureTradeTicksRequest, FutureDepthRequest, FutureTradingTimesRequest, FundSymbolsRequest, FundContractsRequest, FundQuoteRequest, FundHistoryQuoteRequest, WarrantBriefsRequest, WarrantFilterRequest, IndustryListRequest, IndustryStocksRequest, TradingCalendarRequest, FinancialExchangeRateRequest, FinancialCurrencyRequest, MarketScannerTagsRequest, QuoteOvernightRequest } from '../model/quote-requests';
+import type { BriefRequest, DepthQuoteRequest, TradeTickRequest, FutureBriefRequest, SymbolsRequest, TradeMetasRequest, StockDetailsRequest, StockDelayBriefsRequest, KlineRequest, KlineByPageRequest, TimelineRequest, TimelineHistoryRequest, TradeRankRequest, ShortInterestRequest, StockBrokerRequest, StockFundamentalRequest, StockIndustryRequest, KlineQuotaRequest, QuotePermissionRequest, OptionTradeTicksRequest, OptionTimelineRequest, OptionDepthRequest, OptionSymbolsRequest, OptionAnalysisRequest, FutureContractSingleRequest, AllFutureContractsRequest, FutureContinuousContractsRequest, FutureHistoryMainContractRequest, FutureKlineRequest, FutureKlineByPageRequest, FutureTradeTicksRequest, FutureDepthRequest, FutureTradingTimesRequest, FundSymbolsRequest, FundContractsRequest, FundQuoteRequest, FundHistoryQuoteRequest, WarrantBriefsRequest, WarrantFilterRequest, IndustryListRequest, IndustryStocksRequest, TradingCalendarRequest, FinancialExchangeRateRequest, FinancialCurrencyRequest, MarketScannerTagsRequest, QuoteOvernightRequest } from '../model/quote-requests';
 /**
  * Parse an OCC-style option identifier like "AAPL  260619C00150000"
  * into its component parts.
@@ -57,6 +57,7 @@ export declare class QuoteClient {
     getBrief(req: BriefRequest): Promise<Brief[]>;
     getKline(req: KlineRequest): Promise<Kline[]>;
     getTimeline(symbols: string[]): Promise<Timeline[]>;
+    getTimeline(req: TimelineRequest): Promise<Timeline[]>;
     /** Tick-by-tick trades. wire: trade_tick */
     getTradeTick(req: TradeTickRequest): Promise<TradeTick[]>;
     /** Depth snapshot. wire: quote_depth */
@@ -129,11 +130,18 @@ export declare class QuoteClient {
     getStockFundamental(req: StockFundamentalRequest): Promise<Record<string, unknown>>;
     /** Stock industry classification (array). wire: stock_industry */
     getStockIndustry(req: StockIndustryRequest): Promise<StockIndustry[]>;
-    /** Quote permission detail. wire: get_quote_permission */
+    /** Market data permission entries. wire: get_quote_permission */
     getQuotePermission(req: QuotePermissionRequest): Promise<QuotePermission[]>;
     /** K-line quota usage. wire: kline_quota */
     getKlineQuota(req: KlineQuotaRequest): Promise<KlineQuota[]>;
-    /** Option tick trades. wire: option_trade_tick */
+    /** Option tick trades. wire: option_trade_tick
+     *
+     * Server expects `biz_content` as a top-level JSON array (matches Java's
+     * `BatchApiModel` and Python's `MultipleContractParams.to_openapi_dict`).
+     * We unwrap the request here so the array is emitted directly instead of
+     * `{"contracts": [...]}`. Sending it as an object triggers
+     * `biz param error(failed to parse parameters in 'biz_content')`.
+     */
     getOptionTradeTicks(req: OptionTradeTicksRequest): Promise<TradeTick[]>;
     /** Option intraday timeline. wire: option_timeline */
     getOptionTimeline(req: OptionTimelineRequest): Promise<Timeline[]>;
@@ -154,7 +162,9 @@ export declare class QuoteClient {
     /** Historical main contracts. wire: future_main_contract */
     getFutureHistoryMainContract(req: FutureHistoryMainContractRequest): Promise<FutureMainContractHistory[]>;
     /** Futures K-line. wire: future_kline
-     * beginTime / endTime default to -1 when unset (server requires them present). */
+     * beginTime / endTime default to -1 when unset (server requires them present).
+     * Server expects `contract_codes` (plural) — normalize singular `contractCode`
+     * to the plural form so callers can pass either shape. */
     getFutureKline(req: FutureKlineRequest): Promise<FutureKline[]>;
     /** Client-side paginated futures K-line fetch. */
     getFutureKlineByPage(req: FutureKlineByPageRequest): Promise<FutureKlineItem[]>;
@@ -180,8 +190,19 @@ export declare class QuoteClient {
     getWarrantBriefs(req: WarrantBriefsRequest): Promise<WarrantBrief[]>;
     /** Warrant filter (paged). wire: warrant_filter */
     getWarrantFilter(req: WarrantFilterRequest): Promise<WarrantFilterResult | undefined>;
-    /** Industry list. wire: industry_list */
-    getIndustryList(req: IndustryListRequest): Promise<IndustryItem[]>;
+    /** Industry list. wire: industry_list
+     *
+     * `industryLevel` is required by the server — omitting it returns
+     * `industry level error, all supported is: [GSECTOR, GGROUP, GIND, GSUBIND]`.
+     * Defaults to `GGROUP` when unset, matching Python SDK's
+     * `IndustryLevel.GGROUP` default.
+     *
+     * Wire fields differ from other endpoints (see `IndustryItem`): server sends
+     * `nameCN` / `nameEN` / `industryLevel`. This method hydrates the
+     * backwards-compat `name` (from `nameEN || nameCN`) and mirrors
+     * `industryLevel` to `level` so existing callers keep working.
+     */
+    getIndustryList(req?: IndustryListRequest): Promise<IndustryItem[]>;
     /** Stocks inside an industry. wire: industry_stock_list */
     getIndustryStocks(req: IndustryStocksRequest): Promise<IndustryStock[]>;
     /** Corporate split (flattened). wire: corporate_action (action_type=split) */

package/dist/types/trade/trade-client.d.ts

@@ -51,6 +51,21 @@ export declare class TradeClient {
      * `symbol` is the underlying (e.g. "AAPL"); `expiry` is "YYYYMMDD".
      */
     getQuoteContract(symbol: string, secType: string, expiry: string): Promise<Contract[]>;
+    /**
+     * Prepare an order request for the wire.
+     *
+     * The gateway expects `algo_params` as a `[{tag, value}, ...]` array
+     * (matching the Python SDK's AlgoParams.to_dict serialization), not the
+     * plain object shape that reads naturally in TypeScript. This helper
+     * normalizes the object form into the array form on outbound payloads
+     * so callers can pass the natural object and TWAP/VWAP orders work end
+     * to end without wire-format workarounds.
+     *
+     * Fields with undefined/null values are dropped; empty algoParams
+     * becomes an empty array rather than being stripped, matching the
+     * Python SDK behavior when the user passes an empty AlgoParams().
+     */
+    private marshalOrderForWire;
     placeOrder(order: OrderRequest): Promise<PlaceOrderResult | undefined>;
     previewOrder(order: OrderRequest): Promise<PreviewResult | undefined>;
     modifyOrder(id: number | string, order: OrderRequest): Promise<OrderIdResult | undefined>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tigeropenapi/tigeropen",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "description": "Tiger Brokers OpenAPI TypeScript SDK for market data, trading, and real-time push",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -30,6 +30,8 @@
     "prepublishOnly": "npm run build",
     "publish:all": "npm run build && npm publish --registry https://registry.npmjs.org --access public && npm pkg set name=tigeropen && npm publish --registry https://registry.npmjs.org && npm pkg set name=@tigeropenapi/tigeropen",
     "test": "vitest run",
+    "test:unit": "vitest run --config vitest.config.ts",
+    "test:integ": "TIGER_RUN_INTEG=true vitest run --config vitest.integ.config.ts",
     "test:watch": "vitest",
     "clean": "rm -rf dist",
     "proto:generate": "protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto --ts_proto_out=./src/push/pb --ts_proto_opt=esModuleInterop=true,outputEncodeMethods=true,outputJsonMethods=false,outputClientImpl=false -I=./proto ./proto/*.proto"