laplace-api 1.0.11 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "laplace-api",
-  "version": "1.0.11",
+  "version": "1.1.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/capital_increase.ts

@@ -0,0 +1,80 @@
+import { Client } from './client';
+import { Region, Locale } from './collections';
+
+// type PaginatedResponse[T any] struct {
+// 	RecordCount int `json:"recordCount"`
+// 	Items       []T `json:"items"`
+// }
+
+export interface PaginatedResponse<T> {
+  recordCount: number;
+  items: T[];
+}
+
+export interface CapitalIncrease {
+  id: number;
+  boardDecisionDate: string;
+  registeredCapitalCeiling: string;
+  currentCapital: string;
+  targetCapital: string;
+  types: string[];
+  spkApplicationResult: string;
+  spkApplicationDate: string;
+  spkApprovalDate: string;
+  paymentDate: string;
+  registrationDate: string;
+  specifiedCurrency: string;
+  symbol: string;
+  relatedDisclosureIDs: number[];
+  rightsRate: string;
+  rightsPrice: string;
+  rightsTotalAmount: string;
+  rightsStartDate: string;
+  rightsEndDate: string;
+  bonusRate: string;
+  bonusTotalAmount: string;
+  bonusStartDate: string;
+  bonusDividendRate: string;
+  bonusDividendTotalAmount: string;
+  externalCapitalIncreaseAmount: string;
+  externalCapitalIncreaseRate: string;
+}
+
+export class CapitalIncreaseClient extends Client {
+  async getAllCapitalIncreases(
+    page: number,
+    size: number,
+    region: Region
+  ): Promise<PaginatedResponse<CapitalIncrease>> {
+    return this.sendRequest<PaginatedResponse<CapitalIncrease>>({
+      method: 'GET',
+      url: '/api/v1/capital-increase/all',
+      params: { region, page, size },
+    });
+  }
+
+  async getCapitalIncreasesForInstrument(
+    symbol: string,
+    page: number,
+    size: number,
+    region: Region,
+  ): Promise<PaginatedResponse<CapitalIncrease>> {
+    return this.sendRequest<PaginatedResponse<CapitalIncrease>>({
+      method: 'GET',
+      url: '/api/v1/capital-increase/' + symbol,
+      params: { region, page, size },
+    });
+  }
+
+  async getActiveRightsForInstrument(
+    symbol: string,
+    date: string,
+    region: Region
+  ): Promise<CapitalIncrease[]> {
+    return this.sendRequest<CapitalIncrease[]>({
+      method: 'GET',
+      url: '/api/v1/rights/active/' + symbol,
+      params: { date, region },
+    });
+  }
+}

package/src/client/stocks.ts

@@ -25,6 +25,14 @@ export enum HistoricalPricePeriod {
   FiveYear = '5Y',
 }
 
+export enum HistoricalPriceInterval {
+  OneMinute = "1m",
+  FiveMinute = "5m",
+  ThirtyMinute = "30m",
+  OneHour = "1h",
+  OneDay = "24h",
+}
+
 export interface Stock {
   id: string;
   assetType: AssetType;
@@ -34,6 +42,7 @@ export interface Stock {
   industryId: string;
   updatedDate: string;
   dailyChange?: number;
+  active: boolean;
 }
 
 export interface LocaleString {
@@ -54,6 +63,19 @@ export interface StockDetail {
   sectorId: string;
   industryId: string;
   updatedDate: string;
+  active: boolean;
+  markets: Market[];
+}
+
+export enum Market {
+  Yildiz = "YILDIZ",
+  Ana = "ANA",
+  Alt = "ALT",
+  YakinIzleme = "YAKIN_IZLEME",
+  POIP = "POIP",
+  Fon = "FON",
+  Girisim = "GIRISIM",
+  Emtia = "EMTIA",
 }
 
 export interface PriceDataPoint {
@@ -76,6 +98,28 @@ export interface StockPriceGraph {
   '5Y': PriceDataPoint[];
 }
 
+export interface StockRestriction {
+  id: number;
+  title: string;
+  description: string;
+  startDate: string;
+  endDate: string;
+}
+
+export interface TickRule {
+  basePrice: number;
+  additionalPrice: number;
+  lowerPriceLimit: number;
+  upperPriceLimit: number;
+  rules: TickSizeRule[];
+}
+
+export interface TickSizeRule {
+  priceFrom: number;
+  priceTo: number;
+  tickSize: number;
+}
+
 export class StockClient extends Client {
   async getAllStocks(region: Region): Promise<Stock[]> {
     return this.sendRequest<Stock[]>({
@@ -112,4 +156,39 @@ export class StockClient extends Client {
       },
     });
   }
-}
+
+  async getCustomHistoricalPrices(stock: string, region: Region, fromDate: string, toDate: string, interval: HistoricalPriceInterval, detail: boolean): Promise<PriceDataPoint[]> {
+    this.validateCustomHistoricalPriceDate(fromDate);
+    this.validateCustomHistoricalPriceDate(toDate);
+
+    return this.sendRequest<PriceDataPoint[]>({
+      method: 'GET',
+      url: '/api/v1/stock/price/interval',
+      params: { stock, region, fromDate, toDate, interval, detail },
+    });
+  }
+
+  async validateCustomHistoricalPriceDate(date: string) {
+    const pattern =  /^\d{4}-\d{2}-\d{2}( \d{2}:\d{2}:\d{2})?$/;
+    const matched = date.match(pattern);
+    if (!matched) {
+      throw new Error("Invalid date format, allowed formats: YYYY-MM-DD, YYYY-MM-DD HH:MM:SS");
+    }
+  }
+
+  async getStockRestrictions(symbol: string, region: Region): Promise<StockRestriction[]> {
+    return this.sendRequest<StockRestriction[]>({
+      method: 'GET',
+      url: '/api/v1/stock/restrictions',
+      params: { symbol, region },
+    });
+  }
+
+  async getTickRules(symbol: string, region: Region): Promise<TickRule> {
+    return this.sendRequest<TickRule>({
+      method: 'GET',
+      url: '/api/v1/stock/rules',
+      params: { symbol, region },
+    });
+  }
+}

package/src/test/capital_increase.test.ts

@@ -0,0 +1,36 @@
+import { Logger } from 'winston';
+import { LaplaceConfiguration } from '../utilities/configuration';
+import { CapitalIncreaseClient } from '../client/capital_increase';
+import { Region } from '../client/collections';
+import './client_test_suite';
+
+
+describe('Capital Increase', () => {
+  let client: CapitalIncreaseClient;
+
+  beforeAll(() => {
+    // Assuming global.testSuite is set up as in the previous example
+    const config = (global as any).testSuite.config as LaplaceConfiguration;
+    const logger: Logger = {
+      info: jest.fn(),
+      error: jest.fn(),
+      warn: jest.fn(),
+      debug: jest.fn(),
+    } as unknown as Logger;
+
+    client = new CapitalIncreaseClient(config, logger);
+  });
+
+  test('GetAllCapitalIncreases', async () => {
+    await client.getAllCapitalIncreases(1, 10, Region.Tr, );
+  });
+
+  test('GetCapitalIncreasesForInstrument', async () => {
+    await client.getCapitalIncreasesForInstrument("TUPRS", 1, 10, Region.Tr);
+  });
+
+  test('GetActiveRightsForInstrument', async () => {
+     await client.getActiveRightsForInstrument("TUPRS", "2024-01-01", Region.Tr);
+  });
+
+});

package/src/test/stocks.test.ts

@@ -1,6 +1,6 @@
 import { Logger } from 'winston';
 import { LaplaceConfiguration } from '../utilities/configuration';
-import { StockClient, AssetClass, HistoricalPricePeriod } from '../client/stocks';
+import { StockClient, AssetClass, HistoricalPricePeriod, HistoricalPriceInterval } from '../client/stocks';
 import { Region, Locale } from '../client/collections';
 import './client_test_suite';
 
@@ -48,4 +48,43 @@ describe('Stocks', () => {
       expect(price).not.toBeEmpty();
     }
   });
-});
+
+  test('GetCustomHistoricalPrices', async () => {
+    let resp = await client.getCustomHistoricalPrices(
+      "TUPRS",
+      Region.Tr,
+      "2024-01-01",
+      "2024-03-01",
+      HistoricalPriceInterval.OneDay,
+      false
+    );
+    expect(resp).not.toBeEmpty();
+
+    for (const price of resp) {
+      expect(price).not.toBeEmpty();
+    }
+
+    resp = await client.getCustomHistoricalPrices(
+      "SASA",
+      Region.Tr,
+      "2024-01-01 10:00:00",
+      "2024-01-05 10:00:00",
+      HistoricalPriceInterval.OneHour,
+      true
+    );
+    expect(resp).not.toBeEmpty();
+
+    for (const price of resp) {
+      expect(price).not.toBeEmpty();
+    }
+  });
+
+  test('GetStockRestrictions', async () => {
+    await client.getStockRestrictions("TUPRS", Region.Tr);
+  });
+
+  test('GetTickRules', async () => {
+    const resp = await client.getTickRules("TUPRS", Region.Tr);
+    expect(resp).not.toBeEmpty();
+  });
+});