@tigeropenapi/tigeropen 0.1.0

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

@@ -0,0 +1,83 @@
+"use strict";
+/**
+ * 推送消息类型定义和数据结构
+ *
+ * 定义 WebSocket 推送消息的类型、主题和数据结构，
+ * 使用 JSON 序列化/反序列化（简化替代 Protobuf）。
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubjectType = exports.MessageType = void 0;
+exports.createPushMessage = createPushMessage;
+exports.serializeMessage = serializeMessage;
+exports.deserializeMessage = deserializeMessage;
+/** 推送消息类型 */
+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 || (exports.MessageType = MessageType = {}));
+/** 订阅主题类型 */
+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 || (exports.SubjectType = SubjectType = {}));
+/**
+ * 创建推送消息
+ */
+function createPushMessage(type, subject, data) {
+    const msg = { type };
+    if (subject)
+        msg.subject = subject;
+    if (data !== undefined)
+        msg.data = data;
+    return msg;
+}
+/**
+ * 序列化推送消息为 JSON 字符串
+ */
+function serializeMessage(msg) {
+    return JSON.stringify(msg);
+}
+/**
+ * 反序列化 JSON 字符串为推送消息
+ */
+function deserializeMessage(data) {
+    return JSON.parse(data);
+}

package/dist/cjs/quote/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuoteClient = void 0;
+/**
+ * 行情模块导出
+ */
+var quote_client_1 = require("./quote-client");
+Object.defineProperty(exports, "QuoteClient", { enumerable: true, get: function () { return quote_client_1.QuoteClient; } });

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

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuoteClient = void 0;
+const api_request_1 = require("../client/api-request");
+/**
+ * 行情查询客户端，封装所有行情相关 API。
+ */
+class QuoteClient {
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * 内部通用方法：构造请求、发送、返回 data 字段
+     */
+    async execute(method, bizParams) {
+        const request = (0, api_request_1.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');
+    }
+}
+exports.QuoteClient = QuoteClient;

package/dist/cjs/signer/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSignContent = exports.verifyWithRSA = exports.signWithRSA = exports.loadPrivateKey = void 0;
+/**
+ * 认证层（RSA Signer）统一导出
+ */
+var signer_1 = require("./signer");
+Object.defineProperty(exports, "loadPrivateKey", { enumerable: true, get: function () { return signer_1.loadPrivateKey; } });
+Object.defineProperty(exports, "signWithRSA", { enumerable: true, get: function () { return signer_1.signWithRSA; } });
+Object.defineProperty(exports, "verifyWithRSA", { enumerable: true, get: function () { return signer_1.verifyWithRSA; } });
+var sign_content_1 = require("./sign-content");
+Object.defineProperty(exports, "getSignContent", { enumerable: true, get: function () { return sign_content_1.getSignContent; } });

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

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

package/dist/cjs/signer/signer.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadPrivateKey = loadPrivateKey;
+exports.signWithRSA = signWithRSA;
+exports.verifyWithRSA = verifyWithRSA;
+/**
+ * RSA 签名模块
+ *
+ * 提供 RSA 私钥加载、SHA1WithRSA 签名和验签功能。
+ * 支持 PKCS#1、PKCS#8 PEM 格式以及裸 Base64 编码。
+ */
+const crypto_1 = require("crypto");
+/**
+ * 加载 RSA 私钥，支持以下格式：
+ * - PKCS#1 PEM（BEGIN RSA PRIVATE KEY）
+ * - PKCS#8 PEM（BEGIN PRIVATE KEY）
+ * - 裸 Base64 编码的 DER 数据（无 PEM 头尾）
+ *
+ * @param keyStr - 私钥字符串
+ * @returns KeyObject 私钥对象
+ * @throws 私钥为空或格式无效时抛出错误
+ */
+function loadPrivateKey(keyStr) {
+    if (!keyStr) {
+        throw new Error('私钥不能为空');
+    }
+    // 尝试 PEM 格式（PKCS#1 或 PKCS#8）
+    if (keyStr.includes('-----BEGIN')) {
+        try {
+            return (0, crypto_1.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 (0, crypto_1.createPrivateKey)({
+            key: derBuffer,
+            format: 'der',
+            type: 'pkcs1',
+        });
+    }
+    catch {
+        // 继续尝试 PKCS#8
+    }
+    // 尝试 PKCS#8 DER
+    try {
+        return (0, crypto_1.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 私钥无效或签名失败时抛出错误
+ */
+function signWithRSA(privateKeyStr, content) {
+    const key = loadPrivateKey(privateKeyStr);
+    const sign = (0, crypto_1.createSign)('SHA1');
+    sign.update(content);
+    sign.end();
+    return sign.sign(key, 'base64');
+}
+/**
+ * 使用 RSA 公钥验证 SHA1WithRSA 签名。
+ *
+ * @param publicKey - 公钥对象
+ * @param content - 原始内容
+ * @param signature - Base64 编码的签名字符串
+ * @returns 验签是否成功
+ */
+function verifyWithRSA(publicKey, content, signature) {
+    const verify = (0, crypto_1.createVerify)('SHA1');
+    verify.update(content);
+    verify.end();
+    return verify.verify(publicKey, signature, 'base64');
+}

package/dist/cjs/trade/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TradeClient = void 0;
+/**
+ * 交易模块导出
+ */
+var trade_client_1 = require("./trade-client");
+Object.defineProperty(exports, "TradeClient", { enumerable: true, get: function () { return trade_client_1.TradeClient; } });

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

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TradeClient = void 0;
+const api_request_1 = require("../client/api-request");
+/**
+ * 交易客户端，封装所有交易相关 API。
+ */
+class TradeClient {
+    constructor(httpClient, account) {
+        this.httpClient = httpClient;
+        this.account = account;
+    }
+    /**
+     * 内部通用方法：构造请求、发送、返回 data 字段
+     */
+    async execute(method, bizParams) {
+        const request = (0, api_request_1.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,
+        });
+    }
+}
+exports.TradeClient = TradeClient;

package/dist/esm/client/api-request.js

@@ -0,0 +1,23 @@
+/**
+ * API 请求构造模块
+ */
+/**
+ * 创建 API 请求，将业务参数序列化为 JSON 字符串作为 bizContent。
+ *
+ * @param method - API 方法名
+ * @param bizParams - 业务参数（对象、字符串或 null）
+ * @returns ApiRequest 对象
+ */
+export function createApiRequest(method, bizParams) {
+    let bizContent;
+    if (typeof bizParams === 'string') {
+        bizContent = bizParams;
+    }
+    else if (bizParams == null) {
+        bizContent = '{}';
+    }
+    else {
+        bizContent = JSON.stringify(bizParams);
+    }
+    return { method, bizContent };
+}

package/dist/esm/client/api-response.js

@@ -0,0 +1,15 @@
+/**
+ * API 响应解析模块
+ */
+import { TigerError } from './errors';
+/**
+ * 解析 API 响应 JSON 字符串。
+ * code 为 0 时返回 ApiResponse；code 不为 0 时抛出 TigerError。
+ */
+export function parseApiResponse(body) {
+    const resp = JSON.parse(body);
+    if (resp.code !== 0) {
+        throw new TigerError(resp.code, resp.message);
+    }
+    return resp;
+}

package/dist/esm/client/errors.js

@@ -0,0 +1,46 @@
+/**
+ * 错误类型定义模块
+ *
+ * 定义 TigerError 及错误码分类逻辑。
+ */
+/**
+ * 根据错误码返回对应的错误分类
+ */
+export function classifyErrorCode(code) {
+    if (code === 0)
+        return 'success';
+    if (code === 5)
+        return 'rate_limit';
+    if (code >= 1000 && code < 1010)
+        return 'common_param_error';
+    if (code >= 1010 && code < 1100)
+        return 'biz_param_error';
+    if (code >= 1100 && code < 1200)
+        return 'trade_global_error';
+    if (code >= 1200 && code < 1300)
+        return 'trade_prime_error';
+    if (code >= 1300 && code < 2100)
+        return 'trade_simulation_error';
+    if (code >= 2100 && code < 2200)
+        return 'quote_stock_error';
+    if (code >= 2200 && code < 2300)
+        return 'quote_option_error';
+    if (code >= 2300 && code < 2400)
+        return 'quote_future_error';
+    if (code >= 2400 && code < 4000)
+        return 'token_error';
+    if (code >= 4000 && code < 5000)
+        return 'permission_error';
+    return 'unknown_error';
+}
+/**
+ * TigerError - 统一错误类型
+ */
+export class TigerError extends Error {
+    constructor(code, message) {
+        super(message);
+        this.name = 'TigerError';
+        this.code = code;
+        this.category = classifyErrorCode(code);
+    }
+}

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

@@ -0,0 +1,145 @@
+import { getSignContent } from '../signer/sign-content';
+import { signWithRSA } from '../signer/signer';
+import { TigerError } from './errors';
+import { defaultRetryPolicy } from './retry';
+import { parseApiResponse } from './api-response';
+/** SDK 版本号 */
+const SDK_VERSION = '0.1.0';
+/** User-Agent 字符串 */
+const USER_AGENT = `openapi-typescript-sdk-${SDK_VERSION}`;
+/** 默认字符集 */
+const DEFAULT_CHARSET = 'UTF-8';
+/** 默认签名类型 */
+const DEFAULT_SIGN_TYPE = 'RSA';
+/** 默认 API 版本 */
+const DEFAULT_VERSION = '2.0';
+/**
+ * HttpClient 封装 HTTP 请求、签名、重试、超时
+ */
+export class HttpClient {
+    constructor(config, retryPolicy) {
+        this.config = config;
+        this.retryPolicy = retryPolicy ?? defaultRetryPolicy();
+    }
+    /**
+     * 构造公共请求参数
+     */
+    buildCommonParams(apiMethod, bizContent) {
+        const params = {
+            tiger_id: this.config.tigerId,
+            method: apiMethod,
+            charset: DEFAULT_CHARSET,
+            sign_type: DEFAULT_SIGN_TYPE,
+            timestamp: new Date().toISOString().replace('T', ' ').substring(0, 19),
+            version: DEFAULT_VERSION,
+            biz_content: bizContent,
+        };
+        if (this.config.language) {
+            params['language'] = this.config.language;
+        }
+        return params;
+    }
+    /**
+     * 对参数进行签名
+     */
+    signParams(params) {
+        const content = getSignContent(params);
+        return signWithRSA(this.config.privateKey, content);
+    }
+    /**
+     * 发送 HTTP POST 请求
+     */
+    async doHttpPost(params) {
+        const body = JSON.stringify(params);
+        const headers = {
+            'Content-Type': 'application/json;charset=UTF-8',
+            'User-Agent': USER_AGENT,
+        };
+        if (this.config.token) {
+            headers['Authorization'] = this.config.token;
+        }
+        const response = await fetch(this.config.serverUrl, {
+            method: 'POST',
+            headers,
+            body,
+            signal: AbortSignal.timeout(this.config.timeout * 1000),
+        });
+        return response.text();
+    }
+    /**
+     * 执行结构化 API 请求，返回解析后的 ApiResponse。
+     * 供 QuoteClient/TradeClient 内部使用。
+     */
+    async executeRequest(request) {
+        const params = this.buildCommonParams(request.method, request.bizContent);
+        const sign = this.signParams(params);
+        params['sign'] = sign;
+        let lastErr;
+        const maxAttempts = this.retryPolicy.shouldRetry(request.method)
+            ? this.retryPolicy.maxRetries + 1
+            : 1;
+        for (let attempt = 0; attempt < maxAttempts; attempt++) {
+            if (attempt > 0) {
+                const backoff = this.retryPolicy.calculateBackoff(attempt - 1);
+                await this.sleep(backoff);
+            }
+            try {
+                const body = await this.doHttpPost(params);
+                return parseApiResponse(body);
+            }
+            catch (err) {
+                lastErr = err;
+                if (!this.retryPolicy.shouldRetry(request.method)) {
+                    throw err;
+                }
+            }
+        }
+        throw lastErr;
+    }
+    /**
+     * 通用 API 调用方法。
+     *
+     * @param apiMethod - API 方法名（如 "market_state"、"place_order"）
+     * @param requestJson - 原始 biz_content JSON 字符串
+     * @returns 原始 response JSON 字符串，不做任何解析
+     */
+    async execute(apiMethod, requestJson) {
+        // 参数校验
+        if (!apiMethod) {
+            throw new TigerError(-1, 'api_method 不能为空');
+        }
+        try {
+            JSON.parse(requestJson);
+        }
+        catch {
+            throw new TigerError(-1, 'request_json 不是有效的 JSON');
+        }
+        const params = this.buildCommonParams(apiMethod, requestJson);
+        const sign = this.signParams(params);
+        params['sign'] = sign;
+        let lastErr;
+        const maxAttempts = this.retryPolicy.shouldRetry(apiMethod)
+            ? this.retryPolicy.maxRetries + 1
+            : 1;
+        for (let attempt = 0; attempt < maxAttempts; attempt++) {
+            if (attempt > 0) {
+                const backoff = this.retryPolicy.calculateBackoff(attempt - 1);
+                await this.sleep(backoff);
+            }
+            try {
+                return await this.doHttpPost(params);
+            }
+            catch (err) {
+                lastErr = err;
+                if (!this.retryPolicy.shouldRetry(apiMethod)) {
+                    throw err;
+                }
+            }
+        }
+        throw lastErr;
+    }
+    /** 延迟指定毫秒 */
+    sleep(ms) {
+        return new Promise((resolve) => setTimeout(resolve, ms));
+    }
+}

package/dist/esm/client/index.js

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