@fin.cx/opendata 3.1.0 → 3.2.2

package/ts/stocks/interfaces/stockdata.ts

@@ -0,0 +1,65 @@
+import type { IStockPrice } from './stockprice.js';
+import type { IStockFundamentals } from './fundamentals.js';
+
+/**
+ * Combined stock data with price and fundamentals
+ * All calculated metrics (market cap, P/E, P/B) are automatically included
+ */
+export interface IStockData {
+  /** Stock ticker symbol */
+  ticker: string;
+
+  /** Price information */
+  price: IStockPrice;
+
+  /** Fundamental data (optional - may not be available for all stocks) */
+  fundamentals?: IStockFundamentals;
+
+  /** When this combined data was fetched */
+  fetchedAt: Date;
+}
+
+/**
+ * Configuration for StockDataService
+ */
+export interface IStockDataServiceConfig {
+  /** Cache configuration */
+  cache?: {
+    /** TTL for price data (default: 24 hours) */
+    priceTTL?: number;
+    /** TTL for fundamentals data (default: 90 days) */
+    fundamentalsTTL?: number;
+    /** Max cache entries (default: 10000) */
+    maxEntries?: number;
+  };
+
+  /** Provider timeouts */
+  timeout?: {
+    /** Timeout for price providers (default: 10000ms) */
+    price?: number;
+    /** Timeout for fundamentals providers (default: 30000ms) */
+    fundamentals?: number;
+  };
+}
+
+/**
+ * Request type for getting complete stock data
+ */
+export interface ICompleteStockDataRequest {
+  ticker: string;
+  /** Whether to include fundamentals (default: true) */
+  includeFundamentals?: boolean;
+  /** Whether to enrich fundamentals with price calculations (default: true) */
+  enrichFundamentals?: boolean;
+}
+
+/**
+ * Batch request for multiple stocks
+ */
+export interface ICompleteStockDataBatchRequest {
+  tickers: string[];
+  /** Whether to include fundamentals (default: true) */
+  includeFundamentals?: boolean;
+  /** Whether to enrich fundamentals with price calculations (default: true) */
+  enrichFundamentals?: boolean;
+}

package/ts/stocks/providers/provider.secedgar.ts

@@ -217,6 +217,7 @@ export class SecEdgarProvider implements IFundamentalsProvider {
   /**
    * Fetch the SEC ticker-to-CIK mapping list
    * Cached for 24 hours (list updates daily)
+   * Uses native fetch for automatic gzip decompression
    */
   private async fetchTickerList(): Promise<any> {
     // Check cache
@@ -230,29 +231,44 @@ export class SecEdgarProvider implements IFundamentalsProvider {
     // Wait for rate limit slot
     await this.rateLimiter.waitForSlot();
 
-    // Fetch from SEC
-    const response = await plugins.smartrequest.SmartRequest.create()
-      .url(this.tickersUrl)
-      .headers({
-        'User-Agent': this.userAgent,
-        'Accept': 'application/json'
-      })
-      .timeout(this.config.timeout)
-      .get();
-
-    const data = await response.json();
-
-    // Cache the list
-    this.tickerListCache = {
-      data,
-      timestamp: new Date()
-    };
+    // Fetch from SEC using native fetch (handles gzip automatically)
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), this.config.timeout);
+
+    try {
+      const response = await fetch(this.tickersUrl, {
+        headers: {
+          'User-Agent': this.userAgent,
+          'Accept': 'application/json'
+          // Note: Accept-Encoding is set automatically by fetch
+        },
+        signal: controller.signal
+      });
+
+      clearTimeout(timeoutId);
+
+      if (!response.ok) {
+        throw new Error(`HTTP ${response.status}: ${response.statusText}`);
+      }
+
+      const data = await response.json();
+
+      // Cache the list
+      this.tickerListCache = {
+        data,
+        timestamp: new Date()
+      };
 
-    return data;
+      return data;
+    } catch (error) {
+      clearTimeout(timeoutId);
+      throw error;
+    }
   }
 
   /**
    * Fetch company facts from SEC EDGAR
+   * Uses native fetch for automatic gzip decompression
    */
   private async fetchCompanyFacts(cik: string): Promise<any> {
     // Pad CIK to 10 digits
@@ -262,26 +278,39 @@ export class SecEdgarProvider implements IFundamentalsProvider {
     // Wait for rate limit slot
     await this.rateLimiter.waitForSlot();
 
-    // Fetch from SEC
-    const response = await plugins.smartrequest.SmartRequest.create()
-      .url(url)
-      .headers({
-        'User-Agent': this.userAgent,
-        'Accept': 'application/json',
-        'Accept-Encoding': 'gzip, deflate',
-        'Host': 'data.sec.gov'
-      })
-      .timeout(this.config.timeout)
-      .get();
-
-    const data = await response.json();
-
-    // Validate response
-    if (!data || !data.facts) {
-      throw new Error('Invalid response from SEC EDGAR API');
-    }
+    // Fetch from SEC using native fetch (handles gzip automatically)
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), this.config.timeout);
 
-    return data;
+    try {
+      const response = await fetch(url, {
+        headers: {
+          'User-Agent': this.userAgent,
+          'Accept': 'application/json',
+          'Host': 'data.sec.gov'
+          // Note: Accept-Encoding is set automatically by fetch and gzip is handled transparently
+        },
+        signal: controller.signal
+      });
+
+      clearTimeout(timeoutId);
+
+      if (!response.ok) {
+        throw new Error(`HTTP ${response.status}: ${response.statusText}`);
+      }
+
+      const data = await response.json();
+
+      // Validate response
+      if (!data || !data.facts) {
+        throw new Error('Invalid response from SEC EDGAR API');
+      }
+
+      return data;
+    } catch (error) {
+      clearTimeout(timeoutId);
+      throw error;
+    }
   }
 
   /**
@@ -382,20 +411,29 @@ export class SecEdgarProvider implements IFundamentalsProvider {
 
   /**
    * Check if SEC EDGAR API is available
+   * Uses native fetch for automatic gzip decompression
    */
   public async isAvailable(): Promise<boolean> {
     try {
       // Test with Apple's well-known CIK
       const url = `${this.baseUrl}/companyfacts/CIK0000320193.json`;
 
-      const response = await plugins.smartrequest.SmartRequest.create()
-        .url(url)
-        .headers({
+      const controller = new AbortController();
+      const timeoutId = setTimeout(() => controller.abort(), 5000);
+
+      const response = await fetch(url, {
+        headers: {
           'User-Agent': this.userAgent,
           'Accept': 'application/json'
-        })
-        .timeout(5000)
-        .get();
+        },
+        signal: controller.signal
+      });
+
+      clearTimeout(timeoutId);
+
+      if (!response.ok) {
+        return false;
+      }
 
       const data = await response.json();
       return data && data.facts !== undefined;