@fugle/node-twstock 3.0.0-alpha.1 → 3.0.0-alpha.2

package/README.md

@@ -928,7 +928,7 @@ twstock.stocks.splitAnnouncement({ symbol: '1234' })
   * `endDate`: {string} 結束日期 (`'YYYY-MM-DD'`)
   * `exchange` (optional): {string} 市場別 (`'TWSE'`：上市；`'TPEx'`：上櫃)
   * `symbol` (optional): {string} ETF 代號
-  * `reverseSplit` (optional): {boolean} 反分割
+  * `splitType` (optional): {string} 分割類型，可選值: `'split'` (分割)、`'reverse-split'` (反分割)、`'all'` (全部，預設值)
 * Returns: {Promise} 成功時以 {Object[]} 履行，其中 `Object` 包含以下屬性：
   * `resumeDate`: {string} 恢復買賣日期
   * `exchange`: {string} 市場別
@@ -941,8 +941,17 @@ twstock.stocks.splitAnnouncement({ symbol: '1234' })
   * `openingReferencePrice`: {number} 開盤競價基準
 
 ```js
+// 查詢所有類型（預設）
 twstock.stocks.etfSplits({ startDate: '2024-12-01', endDate: '2024-12-31', exchange: 'TWSE' })
   .then(data => console.log(data));
+
+// 只查詢分割
+twstock.stocks.etfSplits({ startDate: '2024-12-01', endDate: '2024-12-31', exchange: 'TWSE', splitType: 'split' })
+  .then(data => console.log(data));
+
+// 只查詢反分割
+twstock.stocks.etfSplits({ startDate: '2024-12-01', endDate: '2024-12-31', exchange: 'TWSE', splitType: 'reverse-split' })
+  .then(data => console.log(data));
 ```
 
 ### `.stocks.etfSplitAnnouncement([options])`
@@ -952,7 +961,7 @@ twstock.stocks.etfSplits({ startDate: '2024-12-01', endDate: '2024-12-31', excha
 * `options`: {Object}
   * `exchange` (optional): {string} 市場別 (`'TWSE'`：上市；`'TPEx'`：上櫃，預設為 `'TWSE'`)
   * `symbol` (optional): {string} ETF 代號
-  * `splitType` (optional): {string} 分割類型 (`'分割'` 或 `'反分割'`)。若未指定則返回所有類型
+  * `splitType` (optional): {string} 分割類型，可選值: `'split'` (分割)、`'reverse-split'` (反分割)、`'all'` (全部，預設值)
 * Returns: {Promise} 成功時以 {Object[]} 履行，其中 `Object` 包含以下屬性：
   * `symbol`: {string} ETF 代號
   * `name`: {string} ETF 名稱

package/lib/scrapers/twse-scraper.d.ts

@@ -66,7 +66,7 @@ export declare class TwseScraper extends Scraper {
         startDate: string;
         endDate: string;
         symbol?: string;
-        reverseSplit?: boolean;
+        splitType?: 'split' | 'reverse-split' | 'all';
     }): Promise<StockSplits[]>;
     fetchStocksSplitAnnouncement(options?: {
         symbol?: string;
@@ -74,6 +74,7 @@ export declare class TwseScraper extends Scraper {
     }): Promise<StocksSplitAnnouncement[]>;
     fetchStocksEtfSplitAnnouncement(options?: {
         symbol?: string;
+        splitType?: 'split' | 'reverse-split' | 'all';
     }): Promise<StocksEtfSplitAnnouncement[]>;
     fetchStocksListingApplicants(options?: {
         symbol?: string;

package/lib/scrapers/twse-scraper.js

@@ -591,7 +591,7 @@ class TwseScraper extends scraper_1.Scraper {
         return symbol ? data.filter((data) => data.symbol === symbol) : data;
     }
     async fetchStocksEtfSplits(options) {
-        const { startDate, endDate, symbol } = options;
+        const { startDate, endDate, symbol, splitType = 'all' } = options;
         const query = new URLSearchParams({
             startDate: luxon_1.DateTime.fromISO(startDate).toFormat('yyyyMMdd'),
             endDate: luxon_1.DateTime.fromISO(endDate).toFormat('yyyyMMdd'),
@@ -615,7 +615,11 @@ class TwseScraper extends scraper_1.Scraper {
             data.openingReferencePrice = (0, utils_1.parseNumeric)(values[4]);
             return data;
         })
-            .filter((row) => options.reverseSplit ? row.type === '反分割' : row.type === '分割')
+            .filter((row) => {
+            if (splitType === 'all')
+                return true;
+            return splitType === 'split' ? row.type === '分割' : row.type === '反分割';
+        })
             .map((row) => _.omit(row, ['type']));
         return symbol ? data.filter((data) => data.symbol === symbol) : data;
     }
@@ -679,6 +683,7 @@ class TwseScraper extends scraper_1.Scraper {
     }
     async fetchStocksEtfSplitAnnouncement(options) {
         var _a;
+        const { symbol: filterSymbol, splitType = 'all' } = options || {};
         const query = new URLSearchParams({
             response: 'json',
             _: Date.now().toString(),
@@ -688,19 +693,24 @@ class TwseScraper extends scraper_1.Scraper {
         const json = ((_a = response.data) === null || _a === void 0 ? void 0 : _a.stat) === 'OK' && response.data;
         if (!json || !json.data)
             return [];
-        const data = json.data.map((row) => {
-            const [haltDate, symbol, name, splitType, resumeDate, splitRatio] = row;
+        let data = json.data.map((row) => {
+            const [haltDate, symbol, name, splitTypeValue, resumeDate, splitRatio] = row;
             const data = {};
             data.symbol = symbol.trim();
             data.name = name.trim();
             data.exchange = enums_1.Exchange.TWSE;
             data.haltDate = (0, utils_1.rocToWestern)(haltDate);
             data.resumeDate = (0, utils_1.rocToWestern)(resumeDate);
-            data.splitType = splitType.trim();
+            data.splitType = splitTypeValue.trim();
             data.splitRatio = (0, utils_1.parseNumeric)(splitRatio);
             return data;
         });
-        return (options === null || options === void 0 ? void 0 : options.symbol) ? data.filter((item) => item.symbol === options.symbol) : data;
+        // Apply splitType filter if specified
+        if (splitType !== 'all') {
+            const targetType = splitType === 'split' ? '分割' : '反分割';
+            data = data.filter(item => item.splitType === targetType);
+        }
+        return filterSymbol ? data.filter((item) => item.symbol === filterSymbol) : data;
     }
     async fetchStocksListingApplicants(options) {
         var _a;

package/lib/twstock.d.ts

@@ -100,12 +100,12 @@ export declare class TwStock {
             startDate: string;
             endDate: string;
             symbol?: string | undefined;
-            reverseSplit?: boolean | undefined;
+            splitType?: "split" | "reverse-split" | "all" | undefined;
         }) => Promise<import("./interfaces").StockSplits[]>;
         etfSplitAnnouncement: (options?: {
             exchange?: "TWSE" | "TPEx" | undefined;
             symbol?: string | undefined;
-            splitType?: "分割" | "反分割" | undefined;
+            splitType?: "split" | "reverse-split" | "all" | undefined;
         } | undefined) => Promise<import("./interfaces").StocksEtfSplitAnnouncement[]>;
         listingApplicants: (options?: {
             exchange?: "TWSE" | "TPEx" | undefined;

package/lib/twstock.js

@@ -203,7 +203,7 @@ class TwStock {
             : await this._scraper.getTwseScraper().fetchStocksSplits({ symbol, startDate, endDate });
     }
     async fetchStocksEtfSplits(options) {
-        const { startDate, endDate, symbol, reverseSplit } = options;
+        const { startDate, endDate, symbol, splitType = 'all' } = options;
         if (symbol && !this._stocks.has(symbol)) {
             const stocks = await this.loadStocks({ symbol });
             if (!stocks.length)
@@ -212,10 +212,15 @@ class TwStock {
         const ticker = this._stocks.get(symbol);
         const exchange = symbol ? ticker.exchange : options.exchange;
         return (exchange === enums_1.Exchange.TPEx)
-            ? await (reverseSplit
+            ? await (splitType === 'reverse-split'
                 ? this._scraper.getTpexScraper().fetchStocksEtfReverseSplits({ symbol, startDate, endDate })
-                : this._scraper.getTpexScraper().fetchStocksEtfSplits({ symbol, startDate, endDate }))
-            : await this._scraper.getTwseScraper().fetchStocksEtfSplits({ symbol, startDate, endDate, reverseSplit });
+                : splitType === 'split'
+                    ? this._scraper.getTpexScraper().fetchStocksEtfSplits({ symbol, startDate, endDate })
+                    : [
+                        ...await this._scraper.getTpexScraper().fetchStocksEtfSplits({ symbol, startDate, endDate }),
+                        ...await this._scraper.getTpexScraper().fetchStocksEtfReverseSplits({ symbol, startDate, endDate })
+                    ])
+            : await this._scraper.getTwseScraper().fetchStocksEtfSplits({ symbol, startDate, endDate, splitType });
     }
     async fetchStocksDividendsAnnouncement(options) {
         const { exchange = enums_1.Exchange.TWSE, symbol, includeDetail } = options || {};
@@ -236,12 +241,12 @@ class TwStock {
             : await this._scraper.getTwseScraper().fetchStocksSplitAnnouncement({ symbol, includeDetail });
     }
     async fetchStocksEtfSplitAnnouncement(options) {
-        const { exchange = enums_1.Exchange.TWSE, symbol, splitType } = options || {};
+        const { exchange = enums_1.Exchange.TWSE, symbol, splitType = 'all' } = options || {};
         if (exchange === enums_1.Exchange.TPEx) {
             // TPEx has separate endpoints for split and reverse split
-            const data = splitType === '反分割'
+            const data = splitType === 'reverse-split'
                 ? await this._scraper.getTpexScraper().fetchStocksEtfReverseSplitAnnouncement({ symbol })
-                : splitType === '分割'
+                : splitType === 'split'
                     ? await this._scraper.getTpexScraper().fetchStocksEtfSplitAnnouncement({ symbol })
                     : [
                         ...await this._scraper.getTpexScraper().fetchStocksEtfSplitAnnouncement({ symbol }),
@@ -250,8 +255,9 @@ class TwStock {
             return data;
         }
         // TWSE returns all split types in one call, filter by splitType if specified
-        const data = await this._scraper.getTwseScraper().fetchStocksEtfSplitAnnouncement({ symbol });
-        return splitType ? data.filter(item => item.splitType === splitType) : data;
+        const targetType = splitType === 'split' ? '分割' : splitType === 'reverse-split' ? '反分割' : undefined;
+        const data = await this._scraper.getTwseScraper().fetchStocksEtfSplitAnnouncement({ symbol, splitType });
+        return targetType ? data.filter(item => item.splitType === targetType) : data;
     }
     async fetchStocksCapitalReductions(options) {
         const { symbol, startDate, endDate, includeDetail } = options;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fugle/node-twstock",
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.0-alpha.2",
   "description": "A client library for scraping Taiwan stock market data",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",