laplace-api 2.2.0 → 3.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "laplace-api",
-  "version": "2.2.0",
+  "version": "3.0.1",
   "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/financial_ratios.ts

@@ -131,7 +131,7 @@ export interface HistoricalFinancialSheets {
 
 export interface HistoricalFinancialSheet {
   period: string;
-  rows: HistoricalFinancialSheetRow[];
+  items: HistoricalFinancialSheetRow[];
 }
 
 export interface HistoricalFinancialSheetRow {
@@ -212,7 +212,7 @@ export class FinancialClient extends Client  {
     currency: Currency,
     region: Region
   ): Promise<HistoricalFinancialSheets> {
-    const url = new URL(`${this['baseUrl']}/api/v1/stock/historical-financial-sheets`);
+    const url = new URL(`${this['baseUrl']}/api/v2/stock/historical-financial-sheets`);
     url.searchParams.append('symbol', symbol);
     url.searchParams.append('from', `${from.year.toString().padStart(4, '0')}-${from.month.toString().padStart(2, '0')}-${from.day.toString().padStart(2, '0')}`);
     url.searchParams.append('to', `${to.year.toString().padStart(4, '0')}-${to.month.toString().padStart(2, '0')}-${to.day.toString().padStart(2, '0')}`);

package/src/test/financial_ratios.test.ts

@@ -7,6 +7,7 @@ import {
   FinancialSheetType,
   FinancialSheetPeriod,
   Currency,
+  HistoricalFinancialSheetRow,
 } from "../client/financial_ratios";
 import { Region, Locale } from "../client/collections";
 import "./client_test_suite";
@@ -68,12 +69,41 @@ describe('FinancialRatios', () => {
     const resp = await financialClient.getHistoricalFinancialSheets(
       'TUPRS',
       { year: 2022, month: 1, day: 1 },
-      { year: 2023, month: 1, day: 1 },
-      FinancialSheetType.BalanceSheet,
-      FinancialSheetPeriod.Annual,
-      Currency.EUR,
+      { year: 2025, month: 1, day: 1 },
+      FinancialSheetType.CashFlow,
+      FinancialSheetPeriod.Quarterly,
+      Currency.TRY,
       Region.Tr
     );
+
+    expect(resp).toBeDefined();
+    expect(resp).not.toBeNull();
     expect(resp).not.toBeEmpty();
+
+    expect(resp.sheets).toBeDefined();
+    expect(Array.isArray(resp.sheets)).toBe(true);
+    expect(resp.sheets.length).toBeGreaterThan(0);
+
+    const firstSheet = resp.sheets[0];
+    expect(firstSheet).toBeDefined();
+
+    expect(firstSheet.period).toBeDefined();
+    expect(typeof firstSheet.period).toBe("string")
+
+    expect(firstSheet.items).toBeDefined();
+    expect(Array.isArray(firstSheet.items)).toBe(true);
+    expect(firstSheet.items.length).toBeGreaterThan(0);
+
+    const firstRow = firstSheet.items[0];
+    expect(firstRow).toBeDefined();
+
+    expect(firstRow).toMatchObject<HistoricalFinancialSheetRow>({
+      description: expect.any(String),
+      value: expect.any(Number),
+      lineCodeId: expect.any(Number),
+      indentLevel: expect.any(Number),
+      firstAncestorLineCodeId: expect.any(Number),
+      sectionLineCodeId: expect.any(Number),
+    });
   });
-});
+});