@tigeropenapi/tigeropen 0.1.0

package/dist/esm/push/push-message.js

@@ -0,0 +1,77 @@
+/**
+ * 推送消息类型定义和数据结构
+ *
+ * 定义 WebSocket 推送消息的类型、主题和数据结构，
+ * 使用 JSON 序列化/反序列化（简化替代 Protobuf）。
+ */
+/** 推送消息类型 */
+export var MessageType;
+(function (MessageType) {
+    // 连接相关
+    MessageType["Connect"] = "connect";
+    MessageType["Connected"] = "connected";
+    MessageType["Disconnect"] = "disconnect";
+    MessageType["Heartbeat"] = "heartbeat";
+    MessageType["Kickout"] = "kickout";
+    MessageType["Error"] = "error";
+    // 订阅相关
+    MessageType["Subscribe"] = "subscribe";
+    MessageType["Unsubscribe"] = "unsubscribe";
+    // 行情推送
+    MessageType["Quote"] = "quote";
+    MessageType["Tick"] = "tick";
+    MessageType["Depth"] = "depth";
+    MessageType["Option"] = "option";
+    MessageType["Future"] = "future";
+    MessageType["Kline"] = "kline";
+    MessageType["StockTop"] = "stock_top";
+    MessageType["OptionTop"] = "option_top";
+    MessageType["FullTick"] = "full_tick";
+    MessageType["QuoteBBO"] = "quote_bbo";
+    // 账户推送
+    MessageType["Asset"] = "asset";
+    MessageType["Position"] = "position";
+    MessageType["Order"] = "order";
+    MessageType["Transaction"] = "transaction";
+})(MessageType || (MessageType = {}));
+/** 订阅主题类型 */
+export var SubjectType;
+(function (SubjectType) {
+    SubjectType["Quote"] = "quote";
+    SubjectType["Tick"] = "tick";
+    SubjectType["Depth"] = "depth";
+    SubjectType["Option"] = "option";
+    SubjectType["Future"] = "future";
+    SubjectType["Kline"] = "kline";
+    SubjectType["StockTop"] = "stock_top";
+    SubjectType["OptionTop"] = "option_top";
+    SubjectType["FullTick"] = "full_tick";
+    SubjectType["QuoteBBO"] = "quote_bbo";
+    SubjectType["Asset"] = "asset";
+    SubjectType["Position"] = "position";
+    SubjectType["Order"] = "order";
+    SubjectType["Transaction"] = "transaction";
+})(SubjectType || (SubjectType = {}));
+/**
+ * 创建推送消息
+ */
+export function createPushMessage(type, subject, data) {
+    const msg = { type };
+    if (subject)
+        msg.subject = subject;
+    if (data !== undefined)
+        msg.data = data;
+    return msg;
+}
+/**
+ * 序列化推送消息为 JSON 字符串
+ */
+export function serializeMessage(msg) {
+    return JSON.stringify(msg);
+}
+/**
+ * 反序列化 JSON 字符串为推送消息
+ */
+export function deserializeMessage(data) {
+    return JSON.parse(data);
+}

package/dist/esm/quote/index.js

@@ -0,0 +1,4 @@
+/**
+ * 行情模块导出
+ */
+export { QuoteClient } from './quote-client';

package/dist/esm/quote/quote-client.js

@@ -0,0 +1,106 @@
+import { createApiRequest } from '../client/api-request';
+/**
+ * 行情查询客户端，封装所有行情相关 API。
+ */
+export class QuoteClient {
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * 内部通用方法：构造请求、发送、返回 data 字段
+     */
+    async execute(method, bizParams) {
+        const request = createApiRequest(method, bizParams);
+        const response = await this.httpClient.executeRequest(request);
+        return response.data;
+    }
+    // === 基础行情方法 ===
+    /** 获取市场状态 */
+    async marketState(market) {
+        return this.execute('market_state', { market });
+    }
+    /** 获取实时报价 */
+    async quoteRealTime(symbols) {
+        return this.execute('quote_real_time', { symbols });
+    }
+    /** 获取 K 线数据 */
+    async kline(symbol, period) {
+        return this.execute('kline', { symbols: [symbol], period });
+    }
+    /** 获取分时数据 */
+    async timeline(symbols) {
+        return this.execute('timeline', { symbols });
+    }
+    /** 获取逐笔成交数据 */
+    async tradeTick(symbols) {
+        return this.execute('trade_tick', { symbols });
+    }
+    /** 获取深度行情 */
+    async quoteDepth(symbol) {
+        return this.execute('quote_depth', { symbol });
+    }
+    // === 期权行情方法 ===
+    /** 获取期权到期日 */
+    async optionExpiration(symbol) {
+        return this.execute('option_expiration', { symbols: [symbol] });
+    }
+    /** 获取期权链 */
+    async optionChain(symbol, expiry) {
+        return this.execute('option_chain', { symbol, expiry });
+    }
+    /** 获取期权报价 */
+    async optionBrief(identifiers) {
+        return this.execute('option_brief', { identifiers });
+    }
+    /** 获取期权 K 线 */
+    async optionKline(identifier, period) {
+        return this.execute('option_kline', { identifier, period });
+    }
+    // === 期货行情方法 ===
+    /** 获取期货交易所列表 */
+    async futureExchange() {
+        return this.execute('future_exchange', { sec_type: 'FUT' });
+    }
+    /** 获取期货合约列表 */
+    async futureContracts(exchange) {
+        return this.execute('future_contracts', { exchange });
+    }
+    /** 获取期货实时报价 */
+    async futureRealTimeQuote(symbols) {
+        return this.execute('future_real_time_quote', { symbols });
+    }
+    /** 获取期货 K 线 */
+    async futureKline(symbol, period) {
+        return this.execute('future_kline', { symbol, period });
+    }
+    // === 基本面和资金流向方法 ===
+    /** 获取财务日报 */
+    async financialDaily(symbol) {
+        return this.execute('financial_daily', { symbol });
+    }
+    /** 获取财务报告 */
+    async financialReport(symbol) {
+        return this.execute('financial_report', { symbol });
+    }
+    /** 获取公司行动 */
+    async corporateAction(symbol) {
+        return this.execute('corporate_action', { symbol });
+    }
+    /** 获取资金流向 */
+    async capitalFlow(symbol) {
+        return this.execute('capital_flow', { symbol });
+    }
+    /** 获取资金分布 */
+    async capitalDistribution(symbol) {
+        return this.execute('capital_distribution', { symbol });
+    }
+    // === 选股器和行情权限方法 ===
+    /** 选股器 */
+    async marketScanner(params) {
+        return this.execute('market_scanner', params);
+    }
+    /** 获取行情权限 */
+    async grabQuotePermission() {
+        return this.execute('grab_quote_permission');
+    }
+}

package/dist/esm/signer/index.js

@@ -0,0 +1,5 @@
+/**
+ * 认证层（RSA Signer）统一导出
+ */
+export { loadPrivateKey, signWithRSA, verifyWithRSA } from './signer';
+export { getSignContent } from './sign-content';

package/dist/esm/signer/sign-content.js

@@ -0,0 +1,16 @@
+/**
+ * 请求参数排序拼接模块
+ *
+ * 按参数名字母序排列所有参数，拼接为 key=value&key=value 格式，
+ * 用于构造 RSA 签名的待签名内容。
+ */
+/**
+ * 按参数名字母序排列所有参数，拼接为 key=value&key=value 格式。
+ *
+ * @param params - 参数名-值映射
+ * @returns 拼接后的字符串
+ */
+export function getSignContent(params) {
+    const keys = Object.keys(params).sort();
+    return keys.map((k) => `${k}=${params[k]}`).join('&');
+}

package/dist/esm/signer/signer.js

@@ -0,0 +1,88 @@
+/**
+ * RSA 签名模块
+ *
+ * 提供 RSA 私钥加载、SHA1WithRSA 签名和验签功能。
+ * 支持 PKCS#1、PKCS#8 PEM 格式以及裸 Base64 编码。
+ */
+import { createSign, createVerify, createPrivateKey } from 'crypto';
+/**
+ * 加载 RSA 私钥，支持以下格式：
+ * - PKCS#1 PEM（BEGIN RSA PRIVATE KEY）
+ * - PKCS#8 PEM（BEGIN PRIVATE KEY）
+ * - 裸 Base64 编码的 DER 数据（无 PEM 头尾）
+ *
+ * @param keyStr - 私钥字符串
+ * @returns KeyObject 私钥对象
+ * @throws 私钥为空或格式无效时抛出错误
+ */
+export function loadPrivateKey(keyStr) {
+    if (!keyStr) {
+        throw new Error('私钥不能为空');
+    }
+    // 尝试 PEM 格式（PKCS#1 或 PKCS#8）
+    if (keyStr.includes('-----BEGIN')) {
+        try {
+            return createPrivateKey(keyStr);
+        }
+        catch {
+            throw new Error('无法解析私钥：PEM 格式无效');
+        }
+    }
+    // 非 PEM 格式，尝试作为裸 Base64 解码
+    // 先尝试 PKCS#1，再尝试 PKCS#8
+    const derBuffer = Buffer.from(keyStr, 'base64');
+    if (derBuffer.length === 0) {
+        throw new Error('无法解析私钥：不是有效的 PEM 或 Base64 格式');
+    }
+    // 尝试 PKCS#1 DER
+    try {
+        return createPrivateKey({
+            key: derBuffer,
+            format: 'der',
+            type: 'pkcs1',
+        });
+    }
+    catch {
+        // 继续尝试 PKCS#8
+    }
+    // 尝试 PKCS#8 DER
+    try {
+        return createPrivateKey({
+            key: derBuffer,
+            format: 'der',
+            type: 'pkcs8',
+        });
+    }
+    catch {
+        throw new Error('无法解析私钥：不是有效的 PKCS#1 或 PKCS#8 格式');
+    }
+}
+/**
+ * 使用 RSA 私钥对内容进行 SHA1WithRSA 签名，返回 Base64 编码的签名字符串。
+ *
+ * @param privateKeyStr - 私钥字符串（支持 PKCS#1/PKCS#8 PEM 或裸 Base64）
+ * @param content - 待签名内容
+ * @returns Base64 编码的签名字符串
+ * @throws 私钥无效或签名失败时抛出错误
+ */
+export function signWithRSA(privateKeyStr, content) {
+    const key = loadPrivateKey(privateKeyStr);
+    const sign = createSign('SHA1');
+    sign.update(content);
+    sign.end();
+    return sign.sign(key, 'base64');
+}
+/**
+ * 使用 RSA 公钥验证 SHA1WithRSA 签名。
+ *
+ * @param publicKey - 公钥对象
+ * @param content - 原始内容
+ * @param signature - Base64 编码的签名字符串
+ * @returns 验签是否成功
+ */
+export function verifyWithRSA(publicKey, content, signature) {
+    const verify = createVerify('SHA1');
+    verify.update(content);
+    verify.end();
+    return verify.verify(publicKey, signature, 'base64');
+}

package/dist/esm/trade/index.js

@@ -0,0 +1,4 @@
+/**
+ * 交易模块导出
+ */
+export { TradeClient } from './trade-client';

package/dist/esm/trade/trade-client.js

@@ -0,0 +1,95 @@
+import { createApiRequest } from '../client/api-request';
+/**
+ * 交易客户端，封装所有交易相关 API。
+ */
+export class TradeClient {
+    constructor(httpClient, account) {
+        this.httpClient = httpClient;
+        this.account = account;
+    }
+    /**
+     * 内部通用方法：构造请求、发送、返回 data 字段
+     */
+    async execute(method, bizParams) {
+        const request = createApiRequest(method, bizParams);
+        const response = await this.httpClient.executeRequest(request);
+        return response.data;
+    }
+    // === 合约查询方法 ===
+    /** 查询单个合约 */
+    async contract(symbol, secType) {
+        return this.execute('contract', {
+            account: this.account, symbol, secType,
+        });
+    }
+    /** 批量查询合约 */
+    async contracts(symbols, secType) {
+        return this.execute('contracts', {
+            account: this.account, symbols, secType,
+        });
+    }
+    /** 查询衍生品合约 */
+    async quoteContract(symbol, secType) {
+        return this.execute('quote_contract', {
+            account: this.account, symbol, secType,
+        });
+    }
+    // === 订单操作方法 ===
+    /** 下单 */
+    async placeOrder(order) {
+        const params = { ...order, account: this.account };
+        return this.execute('place_order', params);
+    }
+    /** 预览订单 */
+    async previewOrder(order) {
+        const params = { ...order, account: this.account };
+        return this.execute('preview_order', params);
+    }
+    /** 修改订单 */
+    async modifyOrder(id, order) {
+        const params = { ...order, account: this.account, id };
+        return this.execute('modify_order', params);
+    }
+    /** 取消订单 */
+    async cancelOrder(id) {
+        return this.execute('cancel_order', {
+            account: this.account, id,
+        });
+    }
+    // === 订单查询方法 ===
+    /** 查询全部订单 */
+    async orders() {
+        return this.execute('orders', { account: this.account });
+    }
+    /** 查询待成交订单 */
+    async activeOrders() {
+        return this.execute('active_orders', { account: this.account });
+    }
+    /** 查询已撤销订单 */
+    async inactiveOrders() {
+        return this.execute('inactive_orders', { account: this.account });
+    }
+    /** 查询已成交订单 */
+    async filledOrders() {
+        return this.execute('filled_orders', { account: this.account });
+    }
+    // === 持仓和资产查询方法 ===
+    /** 查询持仓 */
+    async positions() {
+        return this.execute('positions', { account: this.account });
+    }
+    /** 查询资产 */
+    async assets() {
+        return this.execute('assets', { account: this.account });
+    }
+    /** 查询综合账户资产 */
+    async primeAssets() {
+        return this.execute('prime_assets', { account: this.account });
+    }
+    /** 查询订单成交明细 */
+    async orderTransactions(id) {
+        return this.execute('order_transactions', {
+            account: this.account, id,
+        });
+    }
+}

package/dist/types/client/api-request.d.ts

@@ -0,0 +1,18 @@
+/**
+ * API 请求构造模块
+ */
+/** API 请求接口 */
+export interface ApiRequest {
+    /** API 方法名（如 "market_state"、"place_order"） */
+    method: string;
+    /** 业务参数 JSON 字符串 */
+    bizContent: string;
+}
+/**
+ * 创建 API 请求，将业务参数序列化为 JSON 字符串作为 bizContent。
+ *
+ * @param method - API 方法名
+ * @param bizParams - 业务参数（对象、字符串或 null）
+ * @returns ApiRequest 对象
+ */
+export declare function createApiRequest(method: string, bizParams: unknown): ApiRequest;

package/dist/types/client/api-response.d.ts

@@ -0,0 +1,16 @@
+/** API 响应接口 */
+export interface ApiResponse {
+    /** 状态码（0=成功） */
+    code: number;
+    /** 状态描述 */
+    message: string;
+    /** 业务数据 */
+    data: unknown;
+    /** 服务器时间戳 */
+    timestamp: number;
+}
+/**
+ * 解析 API 响应 JSON 字符串。
+ * code 为 0 时返回 ApiResponse；code 不为 0 时抛出 TigerError。
+ */
+export declare function parseApiResponse(body: string): ApiResponse;

package/dist/types/client/errors.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 错误类型定义模块
+ *
+ * 定义 TigerError 及错误码分类逻辑。
+ */
+/** 错误分类 */
+export type ErrorCategory = 'success' | 'common_param_error' | 'biz_param_error' | 'rate_limit' | 'trade_global_error' | 'trade_prime_error' | 'trade_simulation_error' | 'quote_stock_error' | 'quote_option_error' | 'quote_future_error' | 'token_error' | 'permission_error' | 'server_error' | 'unknown_error';
+/**
+ * 根据错误码返回对应的错误分类
+ */
+export declare function classifyErrorCode(code: number): ErrorCategory;
+/**
+ * TigerError - 统一错误类型
+ */
+export declare class TigerError extends Error {
+    code: number;
+    category: ErrorCategory;
+    constructor(code: number, message: string);
+}

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

@@ -0,0 +1,45 @@
+/**
+ * HttpClient - HTTP 客户端
+ *
+ * 封装 HTTP 请求、签名、重试、超时。
+ * 使用 Node.js 内置 fetch（Node 18+）。
+ */
+import type { ClientConfig } from '../config/client-config';
+import { RetryPolicy } from './retry';
+import { type ApiResponse } from './api-response';
+import type { ApiRequest } from './api-request';
+/**
+ * HttpClient 封装 HTTP 请求、签名、重试、超时
+ */
+export declare class HttpClient {
+    private config;
+    private retryPolicy;
+    constructor(config: ClientConfig, retryPolicy?: RetryPolicy);
+    /**
+     * 构造公共请求参数
+     */
+    private buildCommonParams;
+    /**
+     * 对参数进行签名
+     */
+    private signParams;
+    /**
+     * 发送 HTTP POST 请求
+     */
+    private doHttpPost;
+    /**
+     * 执行结构化 API 请求，返回解析后的 ApiResponse。
+     * 供 QuoteClient/TradeClient 内部使用。
+     */
+    executeRequest(request: ApiRequest): Promise<ApiResponse>;
+    /**
+     * 通用 API 调用方法。
+     *
+     * @param apiMethod - API 方法名（如 "market_state"、"place_order"）
+     * @param requestJson - 原始 biz_content JSON 字符串
+     * @returns 原始 response JSON 字符串，不做任何解析
+     */
+    execute(apiMethod: string, requestJson: string): Promise<string>;
+    /** 延迟指定毫秒 */
+    private sleep;
+}

package/dist/types/client/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 传输层模块导出
+ */
+export { HttpClient } from './http-client';
+export { TigerError, classifyErrorCode, type ErrorCategory } from './errors';
+export { RetryPolicy, defaultRetryPolicy, isTradeOperation } from './retry';
+export { type ApiRequest, createApiRequest } from './api-request';
+export { type ApiResponse, parseApiResponse } from './api-response';

package/dist/types/client/retry.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 重试策略模块
+ *
+ * 提供指数退避重试策略，交易操作（place_order/modify_order/cancel_order）跳过重试。
+ */
+/**
+ * 判断是否为交易操作
+ */
+export declare function isTradeOperation(apiMethod: string): boolean;
+/**
+ * 重试策略
+ */
+export declare class RetryPolicy {
+    /** 最大重试次数，默认 5 */
+    maxRetries: number;
+    /** 最大重试总时间（毫秒），默认 60000 */
+    maxRetryTime: number;
+    /** 基础退避时间（毫秒），默认 1000 */
+    baseDelay: number;
+    /** 最大单次退避时间（毫秒），默认 16000 */
+    maxDelay: number;
+    constructor(options?: Partial<RetryPolicy>);
+    /**
+     * 判断指定的 API 方法是否应该重试。
+     * 交易操作跳过重试。
+     */
+    shouldRetry(apiMethod: string): boolean;
+    /**
+     * 计算第 n 次重试的退避等待时间（毫秒，从 0 开始计数）。
+     * 退避公式：min(2^n * baseDelay, maxDelay)
+     */
+    calculateBackoff(retryCount: number): number;
+}
+/**
+ * 返回默认重试策略
+ */
+export declare function defaultRetryPolicy(): RetryPolicy;

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

@@ -0,0 +1,43 @@
+/** 客户端配置接口 */
+export interface ClientConfig {
+    tigerId: string;
+    privateKey: string;
+    account: string;
+    license?: string;
+    language: string;
+    timezone?: string;
+    timeout: number;
+    sandboxDebug: boolean;
+    token?: string;
+    tokenRefreshDuration?: number;
+    serverUrl: string;
+}
+/** 创建配置时的选项参数 */
+export interface ClientConfigOptions {
+    tigerId?: string;
+    privateKey?: string;
+    account?: string;
+    license?: string;
+    language?: string;
+    timezone?: string;
+    timeout?: number;
+    sandboxDebug?: boolean;
+    token?: string;
+    tokenRefreshDuration?: number;
+    serverUrl?: string;
+    /** 是否启用动态域名获取（默认 true） */
+    enableDynamicDomain?: boolean;
+    /** properties 配置文件路径（同步读取） */
+    propertiesFilePath?: string;
+}
+/**
+ * 创建客户端配置。
+ *
+ * 优先级：环境变量 > 代码设置（含配置文件） > 默认值。
+ * 必填字段 tigerId 和 privateKey 为空时抛出错误。
+ *
+ * @param options - 配置选项
+ * @returns 完整的客户端配置对象
+ * @throws tigerId 或 privateKey 为空时抛出错误
+ */
+export declare function createClientConfig(options: ClientConfigOptions): ClientConfig;

package/dist/types/config/config-parser.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 解析 Java properties 格式的配置文件。
+ * 异步读取文件内容后调用 parsePropertiesString 解析。
+ *
+ * @param filePath - 配置文件路径
+ * @returns 键值对映射
+ * @throws 文件不存在或读取失败时抛出错误
+ */
+export declare function parsePropertiesFile(filePath: string): Promise<Record<string, string>>;
+/**
+ * 解析 Java properties 格式的字符串内容。
+ *
+ * @param content - properties 格式的字符串
+ * @returns 键值对映射
+ */
+export declare function parsePropertiesString(content: string): Record<string, string>;

package/dist/types/config/domain.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 动态域名获取模块
+ *
+ * 从域名花园获取动态域名配置，用于 SDK 初始化时自动选择最优服务器地址。
+ */
+/**
+ * 从域名花园获取动态域名配置。
+ * 失败时返回空对象（静默回退）。
+ *
+ * @param license - 牌照类型（如 "TBNZ"）
+ * @returns 域名配置 map（key → URL）
+ */
+export declare function queryDomains(license?: string): Record<string, unknown>;
+/**
+ * 根据动态域名配置和 license 解析服务器地址。
+ * 返回空字符串表示无法解析（应使用默认地址）。
+ */
+export declare function resolveDynamicServerUrl(domainConf: Record<string, unknown>, license?: string): string;

package/dist/types/config/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 配置层导出
+ */
+export { parsePropertiesFile, parsePropertiesString } from './config-parser';
+export { createClientConfig } from './client-config';
+export type { ClientConfig, ClientConfigOptions } from './client-config';
+export { queryDomains, resolveDynamicServerUrl } from './domain';

package/dist/types/config/token-manager.d.ts

@@ -0,0 +1,38 @@
+/** TokenManager 配置选项 */
+export interface TokenManagerOptions {
+    filePath?: string;
+    refreshInterval?: number;
+    /** Token 刷新阈值（秒），0 表示不刷新，最小 30 秒 */
+    refreshDuration?: number;
+}
+/** Token 刷新函数类型 */
+export type RefreshFn = () => Promise<string>;
+/**
+ * Token 管理器
+ */
+export declare class TokenManager {
+    private token;
+    private filePath;
+    private refreshInterval;
+    private refreshDuration;
+    private timer;
+    constructor(options?: TokenManagerOptions);
+    /** 从 properties 文件加载 Token */
+    loadToken(): string;
+    /** 获取当前 Token */
+    getToken(): string;
+    /** 设置 Token 并更新文件 */
+    setToken(token: string): void;
+    /** 将 Token 保存到 properties 文件 */
+    private saveTokenToFile;
+    /**
+     * 判断 Token 是否需要刷新。
+     * 解码 base64 token，提取前 27 字符中的 gen_ts，
+     * 当 (当前时间秒 - gen_ts/1000) > refreshDuration 时返回 true。
+     */
+    shouldTokenRefresh(): boolean;
+    /** 启动后台定期刷新 */
+    startAutoRefresh(refreshFn: RefreshFn): void;
+    /** 停止后台刷新 */
+    stopAutoRefresh(): void;
+}