laplace-api 5.1.0 → 5.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "laplace-api",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "description": "Client library for Laplace API for the US stock market and BIST (Istanbul stock market) fundamental financial data.",
   "main": "index.js",
   "scripts": {

package/src/client/news.ts

@@ -1,124 +1,139 @@
-import {Client} from "./client";
-import {Locale, Region} from "./collections";
-import {PaginatedResponse} from "./capital_increase";
-import {SortDirection} from "./broker";
+import { Client } from "./client";
+import { Locale, Region } from "./collections";
+import { PaginatedResponse } from "./capital_increase";
+import { SortDirection } from "./broker";
 
 export interface NewsHighlights {
-    consumer: string[];
-    energyAndUtilities: string[];
-    finance: string[];
-    healthcare: string[];
-    industrialsAndMaterials: string[];
-    tech: string[];
-    other: string[];
+  consumer: string[];
+  energyAndUtilities: string[];
+  finance: string[];
+  healthcare: string[];
+  industrialsAndMaterials: string[];
+  tech: string[];
+  other: string[];
 }
 
 export enum NewsType {
-    BRIEFS = "briefs",
-    BLOOMBERG = "bloomberg",
-    FDA = "fda",
-    REUTERS = "reuters",
+  BRIEFS = "briefs",
+  BLOOMBERG = "bloomberg",
+  FDA = "fda",
+  REUTERS = "reuters",
 }
 
 export enum NewsOrderBy {
-    TIMESTAMP = "timestamp",
+  TIMESTAMP = "timestamp",
 }
 
 export interface News {
-    url: string;
-    imageUrl: string;
-    timestamp: string;
-    publisherUrl: string;
-    publisher: NewsPublisher;
-    relatedTickers: NewsTicker[];
-    qualityScore: number;
-    createdAt: string;
-    tickers?: NewsTicker[];
-    categories?: NewsCategories;
-    sectors?: NewsSector;
-    content?: NewsContent;
-    industries?: NewsIndustry;
+  url: string;
+  imageUrl: string;
+  timestamp: string;
+  publisherUrl: string;
+  publisher: NewsPublisher;
+  relatedTickers: NewsTicker[];
+  qualityScore: number;
+  createdAt: string;
+  tickers?: NewsTicker[];
+  categories?: NewsCategories;
+  sectors?: NewsSector;
+  content?: NewsContent;
+  industries?: NewsIndustry;
 }
 
 export interface NewsPublisher {
-    name: string;
-    logoUrl: string | null;
+  name: string;
+  logoUrl: string | null;
 }
 
 export interface NewsTicker {
-    id: string;
-    name: string;
-    symbol?: string;
+  id: string;
+  name: string;
+  symbol?: string;
 }
 
 export interface NewsCategories {
-    name: string;
-    newsCount: number;
-    categoryType?: string | null;
-    meanType?: number | null;
+  name: string;
+  newsCount: number;
+  categoryType?: string | null;
+  meanType?: number | null;
 }
 
 export interface NewsSector {
-    name: string;
-    newsCount: number;
-    categoryType?: string | null;
-    meanType?: number | null;
+  name: string;
+  newsCount: number;
+  categoryType?: string | null;
+  meanType?: number | null;
 }
 
 export interface NewsContent {
-    title: string;
-    description: string;
-    content: string[];
-    summary: string[];
-    investorInsight: string;
+  title: string;
+  description: string;
+  content: string[];
+  summary: string[];
+  investorInsight: string;
 }
 
 export interface NewsIndustry {
-    name: string;
-    meanType: number;
+  name: string;
+  meanType: number;
 }
 
 export class NewsClient extends Client {
-    async getHighlights(
-        region: Region,
-        locale: Locale
-      ): Promise<NewsHighlights> {
-        return this.sendRequest<NewsHighlights>({
-          method: "GET",
-          url: "/api/v1/news/highlights",
-          params: {
-            region,
-            locale,
-          },
-        });
-      }
-      
+  async getHighlights(
+    region: Region,
+    locale: Locale
+  ): Promise<NewsHighlights> {
+    return this.sendRequest<NewsHighlights>({
+      method: "GET",
+      url: "/api/v1/news/highlights",
+      params: {
+        region,
+        locale,
+      },
+    });
+  }
 
-    async getNews(
-        region: Region,
-        locale: Locale,
-        newsType?: NewsType,
-        page?: number,
-        size?: number,
-        orderBy?: NewsOrderBy,
-        orderByDirection?: SortDirection,
-        extraFilters?: string
-      ): Promise<PaginatedResponse<News>> {
-        const params = {
-          region,
-          locale,
-          ...(newsType != null && { newsType }),
-          ...(page != null && { page }),
-          ...(size != null && { size }),
-          ...(orderBy != null && { orderBy }),
-          ...(orderByDirection != null && { orderByDirection }),
-          ...(extraFilters != null && { extraFilters }),
-        };
-      
-        return this.sendRequest<PaginatedResponse<News>>({
-          method: "GET",
-          url: "/api/v1/news",
-          params,
-        });
-      }      
+
+  async getNews(
+    region: Region,
+    locale: Locale,
+    newsType?: NewsType,
+    page?: number,
+    size?: number,
+    orderBy?: NewsOrderBy,
+    orderByDirection?: SortDirection,
+    extraFilters?: string
+  ): Promise<PaginatedResponse<News>> {
+    const params = {
+      region,
+      locale,
+      ...(newsType != null && { newsType }),
+      ...(page != null && { page }),
+      ...(size != null && { size }),
+      ...(orderBy != null && { orderBy }),
+      ...(orderByDirection != null && { orderByDirection }),
+      ...(extraFilters != null && { extraFilters }),
+    };
+
+    return this.sendRequest<PaginatedResponse<News>>({
+      method: "GET",
+      url: "/api/v1/news",
+      params,
+    });
+  }
+
+  streamNews(
+    locale: Locale,
+    sectors?: string[],
+    tickers?: string[],
+    categories?: string[],
+    industries?: string[]
+  ): { events: AsyncIterable<News[]>, cancel: () => void } {
+    let url = `${this["baseUrl"]}/api/v1/news/stream?locale=${locale}`;
+    if (sectors?.length) url += `&sectors=${encodeURIComponent(sectors.join(","))}`;
+    if (tickers?.length) url += `&tickers=${encodeURIComponent(tickers.join(","))}`;
+    if (categories?.length) url += `&categories=${encodeURIComponent(categories.join(","))}`;
+    if (industries?.length) url += `&industries=${encodeURIComponent(industries.join(","))}`;
+    return this.sendSSERequest<News[]>(url);
+  }
 }

package/src/test/news.test.ts

@@ -1,4 +1,5 @@
 import { Logger } from "winston";
+import axios from "axios";
 import { LaplaceConfiguration } from "../utilities/configuration";
 import {
   NewsClient,
@@ -10,61 +11,61 @@ import { Region, Locale } from "../client/collections";
 import { SortDirection } from "../client/broker";
 
 const mockNewsHighlightsResponse = {
-    tech: [
-      "Alphabet ve Amazon'un desteğiyle Anthropic, 2026 başlarında Hindistan'ın Bengaluru kentinde bir ofis açacak."
-    ],
-    other: [
-      "ABD Yüksek Mahkemesi, Epic Games'in davası kapsamında Google'ın Play uygulamalarındaki değişikliği engellemeyecek."
-    ],
-    finance: [
-      "Fifth Third Bank, Comerica'yı 10,9 milyar dolara satın alacak ve böylece ABD'nin 9. en büyük bankası olacak."
-    ],
-    consumer: [
-      "Tesla, rekabet ortamında pazar payını geri almak için daha ucuz Model Y ve Model 3'ü piyasaya sürdü; duyuru hisseleri etkiledi."
-    ],
-    healthcare: [
-      "İlaç üreticileri, Amgen ve Novo Nordisk'in de dahil olduğu şekilde, Trump'ın ilaç fiyatlarını düşürme planıyla uyumlu olarak tele-sağlık satışlarını artırıyor."
-    ],
-    energyAndUtilities: [
-      "ABD Enerji Bakanlığı, Stellantis ve GM'ye verilen 1,1 milyar dolarlık hibeleri iptal edebilir."
-    ],
-    industrialsAndMaterials: [
-      "Boeing, bir grevi sona erdirmek için IAM Sendikası ile geçici bir anlaşmaya vardı; detaylar açıklanmadı."
-    ]
-  };
-  
-  const mockNewsResponse = {
-    items: [
-      {
-        url: "https://www.reuters.com/business/energy/commonwealth-lng-wants-more-time-build-planned-export-facility-louisiana-2025-10-07/",
-        content: {
-          title: "Commonwealth LNG wants more time to build planned export facility in Louisiana",
-          content: [
-            "Commonwealth LNG has requested a four-year extension from federal regulators to construct & begin exporting liquefied natural gas..."
-          ],
-          summary: [
-            "Commonwealth LNG has requested a four-year extension from federal regulators..."
-          ],
-          description:
-            "Commonwealth LNG has asked federal regulators for a four-year extension...",
-          investorInsight:
-            "What it means for investors: The extension request could postpone..."
-        },
-        sectors: { name: "Energy", meanType: 9, newsCount: 1 },
-        tickers: [{ id: "6203d1ba1e674875275558f7", name: "EQT Corp", symbol: "EQT" }],
-        imageUrl: "",
-        createdAt: "2025-10-07T17:10:01.560644Z",
-        publisher: { name: "Reuters", logoUrl: null },
-        timestamp: "2025-10-07T16:50:16Z",
-        categories: { name: "Sector News", newsCount: 1, categoryType: "StockSpesific" },
-        industries: { name: "Oil/Gas (Production and Exploration)", meanType: 78 },
-        publisherUrl: "Reuters",
-        qualityScore: 0,
-        relatedTickers: [{ id: "6203d1ba1e674875275558f7", name: "EQT Corp", symbol: "EQT" }]
-      }
-    ],
-    recordCount: 352
-  };
+  tech: [
+    "Alphabet ve Amazon'un desteğiyle Anthropic, 2026 başlarında Hindistan'ın Bengaluru kentinde bir ofis açacak."
+  ],
+  other: [
+    "ABD Yüksek Mahkemesi, Epic Games'in davası kapsamında Google'ın Play uygulamalarındaki değişikliği engellemeyecek."
+  ],
+  finance: [
+    "Fifth Third Bank, Comerica'yı 10,9 milyar dolara satın alacak ve böylece ABD'nin 9. en büyük bankası olacak."
+  ],
+  consumer: [
+    "Tesla, rekabet ortamında pazar payını geri almak için daha ucuz Model Y ve Model 3'ü piyasaya sürdü; duyuru hisseleri etkiledi."
+  ],
+  healthcare: [
+    "İlaç üreticileri, Amgen ve Novo Nordisk'in de dahil olduğu şekilde, Trump'ın ilaç fiyatlarını düşürme planıyla uyumlu olarak tele-sağlık satışlarını artırıyor."
+  ],
+  energyAndUtilities: [
+    "ABD Enerji Bakanlığı, Stellantis ve GM'ye verilen 1,1 milyar dolarlık hibeleri iptal edebilir."
+  ],
+  industrialsAndMaterials: [
+    "Boeing, bir grevi sona erdirmek için IAM Sendikası ile geçici bir anlaşmaya vardı; detaylar açıklanmadı."
+  ]
+};
+
+const mockNewsResponse = {
+  items: [
+    {
+      url: "https://www.reuters.com/business/energy/commonwealth-lng-wants-more-time-build-planned-export-facility-louisiana-2025-10-07/",
+      content: {
+        title: "Commonwealth LNG wants more time to build planned export facility in Louisiana",
+        content: [
+          "Commonwealth LNG has requested a four-year extension from federal regulators to construct & begin exporting liquefied natural gas..."
+        ],
+        summary: [
+          "Commonwealth LNG has requested a four-year extension from federal regulators..."
+        ],
+        description:
+          "Commonwealth LNG has asked federal regulators for a four-year extension...",
+        investorInsight:
+          "What it means for investors: The extension request could postpone..."
+      },
+      sectors: { name: "Energy", meanType: 9, newsCount: 1 },
+      tickers: [{ id: "6203d1ba1e674875275558f7", name: "EQT Corp", symbol: "EQT" }],
+      imageUrl: "",
+      createdAt: "2025-10-07T17:10:01.560644Z",
+      publisher: { name: "Reuters", logoUrl: null },
+      timestamp: "2025-10-07T16:50:16Z",
+      categories: { name: "Sector News", newsCount: 1, categoryType: "StockSpesific" },
+      industries: { name: "Oil/Gas (Production and Exploration)", meanType: 78 },
+      publisherUrl: "Reuters",
+      qualityScore: 0,
+      relatedTickers: [{ id: "6203d1ba1e674875275558f7", name: "EQT Corp", symbol: "EQT" }]
+    }
+  ],
+  recordCount: 352
+};
 
 describe("NewsClient", () => {
   let client: NewsClient;
@@ -150,13 +151,13 @@ describe("NewsClient", () => {
           expect(typeof n.categories.newsCount).toBe("number");
           expect(
             typeof n.categories.categoryType === "string" ||
-              n.categories.categoryType == null ||
-              n.categories.categoryType === undefined
+            n.categories.categoryType == null ||
+            n.categories.categoryType === undefined
           ).toBe(true);
           expect(
             typeof n.categories.meanType === "number" ||
-              n.categories.meanType == null ||
-              n.categories.meanType === undefined
+            n.categories.meanType == null ||
+            n.categories.meanType === undefined
           ).toBe(true);
         }
 
@@ -165,13 +166,13 @@ describe("NewsClient", () => {
           expect(typeof n.sectors.newsCount).toBe("number");
           expect(
             typeof n.sectors.categoryType === "string" ||
-              n.sectors.categoryType == null ||
-              n.sectors.categoryType === undefined
+            n.sectors.categoryType == null ||
+            n.sectors.categoryType === undefined
           ).toBe(true);
           expect(
             typeof n.sectors.meanType === "number" ||
-              n.sectors.meanType == null ||
-              n.sectors.meanType === undefined
+            n.sectors.meanType == null ||
+            n.sectors.meanType === undefined
           ).toBe(true);
         }
 
@@ -189,6 +190,25 @@ describe("NewsClient", () => {
         }
       }
     });
+
+    test("streamNews yields item before timeout or throws gracefully if none arrive", async () => {
+      let newsItemsReceived = 0;
+      const { events, cancel } = client.streamNews(Locale.Tr);
+
+      const receivePromise = (async () => {
+        for await (const items of events) {
+          if (items && items.length > 0) {
+            newsItemsReceived += items.length;
+            break;
+          }
+        }
+      })();
+
+      const timeoutPromise = new Promise((resolve) => setTimeout(resolve, 8000));
+      await Promise.race([receivePromise, timeoutPromise]);
+      cancel();
+      expect(newsItemsReceived).toBeGreaterThanOrEqual(0);
+    });
   });
 
   describe("Mock Tests", () => {
@@ -343,5 +363,72 @@ describe("NewsClient", () => {
         expect(cli.request).toHaveBeenCalledTimes(1);
       });
     });
+
+    describe("streamNews", () => {
+      test("calls correct endpoint/params and correctly yields stream entities", async () => {
+        const eventsList: any[] = [];
+
+        // Mock get response to return a readable stream
+        const mockStreamData = [
+          "data: " + JSON.stringify([{ url: "http://example.com/stream-news-1", publiser: { name: "test-publisher" } }]) + "\n\n",
+          "data: " + JSON.stringify([{ url: "http://example.com/stream-news-2", publiser: { name: "test-publisher-2" } }]) + "\n\n",
+        ];
+
+        const mockAsyncIterator = {
+          async *[Symbol.asyncIterator]() {
+            for (const chunk of mockStreamData) {
+              yield new TextEncoder().encode(chunk);
+            }
+          }
+        };
+
+        const axiosGetSpy = jest.spyOn(axios, 'get').mockResolvedValueOnce({
+          data: mockAsyncIterator
+        });
+
+        const { events, cancel } = client.streamNews(Locale.Tr);
+
+        for await (const newsList of events) {
+          eventsList.push(newsList);
+        }
+
+        expect(axiosGetSpy).toHaveBeenCalledTimes(1);
+        const callArgs = axiosGetSpy.mock.calls[0];
+        expect(callArgs[0]).toBe(`${client["baseUrl"]}/api/v1/news/stream?locale=tr`);
+        expect(callArgs[1]?.responseType).toBe('stream');
+
+        expect(eventsList).toHaveLength(2);
+        expect(eventsList[0][0].url).toBe("http://example.com/stream-news-1");
+        expect(eventsList[1][0].url).toBe("http://example.com/stream-news-2");
+
+        cancel();
+        axiosGetSpy.mockRestore();
+      });
+
+      test("calls correct endpoint with optional parameters", async () => {
+        const mockAsyncIterator = {
+          async *[Symbol.asyncIterator]() {
+            yield new TextEncoder().encode("data: " + JSON.stringify([]) + "\n\n");
+          }
+        };
+
+        const axiosGetSpy = jest.spyOn(axios, 'get').mockResolvedValueOnce({
+          data: mockAsyncIterator
+        });
+
+        const { events, cancel } = client.streamNews(Locale.En, ["tech"], ["AAPL"], ["category"], ["software"]);
+
+        for await (const _ of events) {
+          break;
+        }
+
+        expect(axiosGetSpy).toHaveBeenCalledTimes(1);
+        const callArgs = axiosGetSpy.mock.calls[0];
+        expect(callArgs[0]).toBe(`${client["baseUrl"]}/api/v1/news/stream?locale=en&sectors=tech&tickers=AAPL&categories=category&industries=software`);
+
+        cancel();
+        axiosGetSpy.mockRestore();
+      });
+    });
   });
 });