fmp-node-types 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/index.d.mts +55 -21
  2. package/dist/index.d.ts +55 -21
  3. package/dist/index.js.map +1 -1
  4. package/dist/index.mjs.map +1 -1
  5. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -776,31 +776,44 @@ interface EarningsSurprises {
776
776
  }
777
777
 
778
778
  interface InsiderTradingRSSResponse {
779
- title: string;
780
- fillingDate: string;
781
779
  symbol: string;
782
- link: string;
780
+ filingDate: string;
781
+ transactionDate: string;
783
782
  reportingCik: string;
784
- issuerCik: string;
783
+ companyCik: string;
784
+ transactionType: string;
785
+ securitiesOwned: number;
786
+ reportingName: string;
787
+ typeOfOwner: string;
788
+ acquisitionOrDisposition: string;
789
+ directOrIndirect: string;
790
+ formType: string;
791
+ securitiesTransacted: number;
792
+ price: number;
793
+ securityName: string;
794
+ url: string;
785
795
  }
786
796
  interface InsiderTradingSearchResponse {
787
797
  symbol: string;
788
798
  filingDate: string;
789
799
  transactionDate: string;
790
800
  reportingCik: string;
801
+ companyCik: string;
791
802
  transactionType: string;
792
803
  securitiesOwned: number;
793
- securitiesTransacted: number;
794
- companyCik: string;
795
804
  reportingName: string;
796
805
  typeOfOwner: string;
797
- link: string;
798
- securityName: string;
799
- price: number;
806
+ acquisitionOrDisposition: string;
807
+ directOrIndirect: string;
800
808
  formType: string;
801
- acquistionOrDisposition: string;
809
+ securitiesTransacted: number;
810
+ price: number;
811
+ securityName: string;
812
+ url: string;
802
813
  }
803
- type TransactionTypesResponse = string[];
814
+ type TransactionTypesResponse = {
815
+ transactionType: string;
816
+ }[];
804
817
  interface InsidersBySymbolResponse {
805
818
  typeOfOwner: string;
806
819
  transactionDate: string;
@@ -811,15 +824,15 @@ interface InsiderTradeStatisticsResponse {
811
824
  cik: string;
812
825
  year: number;
813
826
  quarter: number;
814
- purchases: number;
815
- sales: number;
816
- buySellRatio: number;
817
- totalBought: number;
818
- totalSold: number;
819
- averageBought: number;
820
- averageSold: number;
821
- pPurchases: number;
822
- sSales: number;
827
+ acquiredTransactions: number;
828
+ disposedTransactions: number;
829
+ acquiredDisposedRatio: number;
830
+ totalAcquired: number;
831
+ totalDisposed: number;
832
+ averageAcquired: number;
833
+ averageDisposed: number;
834
+ totalPurchases: number;
835
+ totalSales: number;
823
836
  }
824
837
  interface CikMapperResponse {
825
838
  reportingCik: string;
@@ -1001,6 +1014,27 @@ interface MutualFundHolding {
1001
1014
  weightPercent: number;
1002
1015
  }
1003
1016
 
1017
+ interface News {
1018
+ symbol: string;
1019
+ publishedDate: string;
1020
+ publisher: string;
1021
+ title: string;
1022
+ image: string;
1023
+ site: string;
1024
+ text: string;
1025
+ url: string;
1026
+ }
1027
+ interface Article {
1028
+ title: string;
1029
+ date: string;
1030
+ content: string;
1031
+ tickers: string;
1032
+ image: string;
1033
+ link: string;
1034
+ author: string;
1035
+ site: string;
1036
+ }
1037
+
1004
1038
  interface Quote {
1005
1039
  symbol: string;
1006
1040
  name: string;
@@ -1297,4 +1331,4 @@ interface CompaniesPriceListResponse<T> {
1297
1331
  companiesPriceList: T[];
1298
1332
  }
1299
1333
 
1300
- export { type APIResponse, type AvailableCountries, type AvailableExchanges, type AvailableIndexesList, type AvailableIndustries, type AvailableSectors, type BalanceSheet, type BalanceSheetGrowth, type BeneficialOwnershipResponse, type CashFlowStatement, type CashflowGrowth, type CikMapperBySymbolResponse, type CikMapperResponse, type CompaniesPriceListResponse, type CompanyNotes, type CompanyProfile, type CompanyTranscriptData, type CryptoList, type DateRangeParams, type DividendsCalendar, type ETFCountryWeighting, type ETFHolder, type ETFHolding, type ETFHoldingDates, type ETFList, type ETFProfile, type ETFStockExposure, type ETFWeighting, type EarningsCalendar, type EarningsCallTranscript, type EarningsConfirmed, type EarningsHistorical, type EarningsSurprises, type EconomicIndicator, type EconomicIndicatorName, type EconomicsCalendar, type EnterpriseValue, Exchange, type ExecutiveCompensation, type FMPConfig, type FailToDeliverResponse, type FinancialGrowth, type FinancialRatios, type ForexList, type Form13FResponse, type HistoricalEmployeeCount, type HistoricalPriceData, type HistoricalPriceResponse, type HistoricalSharesFloat, type HouseTradingResponse, type IPOCalendar, type IncomeGrowth, type IncomeStatement, type IndividualIndustryClassificationParams, type IndustryClassification, type IndustryClassificationCode, type IndustryClassificationCodesParams, type InsiderTradeStatisticsResponse, type InsiderTradingRSSResponse, type InsiderTradingSearchResponse, type InsidersBySymbolResponse, type InstitutionalHolderResponse, type KeyMetrics, type MarketCap, type MarketHoliday, type MarketHours, type MarketIndex, type MarketPerformance, type MarketSectorPerformance, type MutualFundHolding, type PaginationParams, Period, type PeriodParams, type QueryParams, type Quote, type RSSFeed8KItem, type RSSFeed8KParams, type RSSFeedAllItem, type RSSFeedItem, type RSSFeedParams, type RSSFeedV3Item, type RSSFeedV3Params, type SECFiling, type SECFilingsParams, type Screener, type ScreenerParams, type SenateHouseTradingByNameResponse, type SenateTradingResponse, type SharesFloat, type SplitsCalendar, type StockDividend, type StockDividendResponse, type StockList, type StockListResponse, type StockRealTimePrice, type StockRealTimePriceFull, type StockSplit, type StockSplitResponse, type SymbolParams, TransactionType, type TransactionTypesResponse, type TreasuryRate };
1334
+ export { type APIResponse, type Article, type AvailableCountries, type AvailableExchanges, type AvailableIndexesList, type AvailableIndustries, type AvailableSectors, type BalanceSheet, type BalanceSheetGrowth, type BeneficialOwnershipResponse, type CashFlowStatement, type CashflowGrowth, type CikMapperBySymbolResponse, type CikMapperResponse, type CompaniesPriceListResponse, type CompanyNotes, type CompanyProfile, type CompanyTranscriptData, type CryptoList, type DateRangeParams, type DividendsCalendar, type ETFCountryWeighting, type ETFHolder, type ETFHolding, type ETFHoldingDates, type ETFList, type ETFProfile, type ETFStockExposure, type ETFWeighting, type EarningsCalendar, type EarningsCallTranscript, type EarningsConfirmed, type EarningsHistorical, type EarningsSurprises, type EconomicIndicator, type EconomicIndicatorName, type EconomicsCalendar, type EnterpriseValue, Exchange, type ExecutiveCompensation, type FMPConfig, type FailToDeliverResponse, type FinancialGrowth, type FinancialRatios, type ForexList, type Form13FResponse, type HistoricalEmployeeCount, type HistoricalPriceData, type HistoricalPriceResponse, type HistoricalSharesFloat, type HouseTradingResponse, type IPOCalendar, type IncomeGrowth, type IncomeStatement, type IndividualIndustryClassificationParams, type IndustryClassification, type IndustryClassificationCode, type IndustryClassificationCodesParams, type InsiderTradeStatisticsResponse, type InsiderTradingRSSResponse, type InsiderTradingSearchResponse, type InsidersBySymbolResponse, type InstitutionalHolderResponse, type KeyMetrics, type MarketCap, type MarketHoliday, type MarketHours, type MarketIndex, type MarketPerformance, type MarketSectorPerformance, type MutualFundHolding, type News, type PaginationParams, Period, type PeriodParams, type QueryParams, type Quote, type RSSFeed8KItem, type RSSFeed8KParams, type RSSFeedAllItem, type RSSFeedItem, type RSSFeedParams, type RSSFeedV3Item, type RSSFeedV3Params, type SECFiling, type SECFilingsParams, type Screener, type ScreenerParams, type SenateHouseTradingByNameResponse, type SenateTradingResponse, type SharesFloat, type SplitsCalendar, type StockDividend, type StockDividendResponse, type StockList, type StockListResponse, type StockRealTimePrice, type StockRealTimePriceFull, type StockSplit, type StockSplitResponse, type SymbolParams, TransactionType, type TransactionTypesResponse, type TreasuryRate };
package/dist/index.d.ts CHANGED
@@ -776,31 +776,44 @@ interface EarningsSurprises {
776
776
  }
777
777
 
778
778
  interface InsiderTradingRSSResponse {
779
- title: string;
780
- fillingDate: string;
781
779
  symbol: string;
782
- link: string;
780
+ filingDate: string;
781
+ transactionDate: string;
783
782
  reportingCik: string;
784
- issuerCik: string;
783
+ companyCik: string;
784
+ transactionType: string;
785
+ securitiesOwned: number;
786
+ reportingName: string;
787
+ typeOfOwner: string;
788
+ acquisitionOrDisposition: string;
789
+ directOrIndirect: string;
790
+ formType: string;
791
+ securitiesTransacted: number;
792
+ price: number;
793
+ securityName: string;
794
+ url: string;
785
795
  }
786
796
  interface InsiderTradingSearchResponse {
787
797
  symbol: string;
788
798
  filingDate: string;
789
799
  transactionDate: string;
790
800
  reportingCik: string;
801
+ companyCik: string;
791
802
  transactionType: string;
792
803
  securitiesOwned: number;
793
- securitiesTransacted: number;
794
- companyCik: string;
795
804
  reportingName: string;
796
805
  typeOfOwner: string;
797
- link: string;
798
- securityName: string;
799
- price: number;
806
+ acquisitionOrDisposition: string;
807
+ directOrIndirect: string;
800
808
  formType: string;
801
- acquistionOrDisposition: string;
809
+ securitiesTransacted: number;
810
+ price: number;
811
+ securityName: string;
812
+ url: string;
802
813
  }
803
- type TransactionTypesResponse = string[];
814
+ type TransactionTypesResponse = {
815
+ transactionType: string;
816
+ }[];
804
817
  interface InsidersBySymbolResponse {
805
818
  typeOfOwner: string;
806
819
  transactionDate: string;
@@ -811,15 +824,15 @@ interface InsiderTradeStatisticsResponse {
811
824
  cik: string;
812
825
  year: number;
813
826
  quarter: number;
814
- purchases: number;
815
- sales: number;
816
- buySellRatio: number;
817
- totalBought: number;
818
- totalSold: number;
819
- averageBought: number;
820
- averageSold: number;
821
- pPurchases: number;
822
- sSales: number;
827
+ acquiredTransactions: number;
828
+ disposedTransactions: number;
829
+ acquiredDisposedRatio: number;
830
+ totalAcquired: number;
831
+ totalDisposed: number;
832
+ averageAcquired: number;
833
+ averageDisposed: number;
834
+ totalPurchases: number;
835
+ totalSales: number;
823
836
  }
824
837
  interface CikMapperResponse {
825
838
  reportingCik: string;
@@ -1001,6 +1014,27 @@ interface MutualFundHolding {
1001
1014
  weightPercent: number;
1002
1015
  }
1003
1016
 
1017
+ interface News {
1018
+ symbol: string;
1019
+ publishedDate: string;
1020
+ publisher: string;
1021
+ title: string;
1022
+ image: string;
1023
+ site: string;
1024
+ text: string;
1025
+ url: string;
1026
+ }
1027
+ interface Article {
1028
+ title: string;
1029
+ date: string;
1030
+ content: string;
1031
+ tickers: string;
1032
+ image: string;
1033
+ link: string;
1034
+ author: string;
1035
+ site: string;
1036
+ }
1037
+
1004
1038
  interface Quote {
1005
1039
  symbol: string;
1006
1040
  name: string;
@@ -1297,4 +1331,4 @@ interface CompaniesPriceListResponse<T> {
1297
1331
  companiesPriceList: T[];
1298
1332
  }
1299
1333
 
1300
- export { type APIResponse, type AvailableCountries, type AvailableExchanges, type AvailableIndexesList, type AvailableIndustries, type AvailableSectors, type BalanceSheet, type BalanceSheetGrowth, type BeneficialOwnershipResponse, type CashFlowStatement, type CashflowGrowth, type CikMapperBySymbolResponse, type CikMapperResponse, type CompaniesPriceListResponse, type CompanyNotes, type CompanyProfile, type CompanyTranscriptData, type CryptoList, type DateRangeParams, type DividendsCalendar, type ETFCountryWeighting, type ETFHolder, type ETFHolding, type ETFHoldingDates, type ETFList, type ETFProfile, type ETFStockExposure, type ETFWeighting, type EarningsCalendar, type EarningsCallTranscript, type EarningsConfirmed, type EarningsHistorical, type EarningsSurprises, type EconomicIndicator, type EconomicIndicatorName, type EconomicsCalendar, type EnterpriseValue, Exchange, type ExecutiveCompensation, type FMPConfig, type FailToDeliverResponse, type FinancialGrowth, type FinancialRatios, type ForexList, type Form13FResponse, type HistoricalEmployeeCount, type HistoricalPriceData, type HistoricalPriceResponse, type HistoricalSharesFloat, type HouseTradingResponse, type IPOCalendar, type IncomeGrowth, type IncomeStatement, type IndividualIndustryClassificationParams, type IndustryClassification, type IndustryClassificationCode, type IndustryClassificationCodesParams, type InsiderTradeStatisticsResponse, type InsiderTradingRSSResponse, type InsiderTradingSearchResponse, type InsidersBySymbolResponse, type InstitutionalHolderResponse, type KeyMetrics, type MarketCap, type MarketHoliday, type MarketHours, type MarketIndex, type MarketPerformance, type MarketSectorPerformance, type MutualFundHolding, type PaginationParams, Period, type PeriodParams, type QueryParams, type Quote, type RSSFeed8KItem, type RSSFeed8KParams, type RSSFeedAllItem, type RSSFeedItem, type RSSFeedParams, type RSSFeedV3Item, type RSSFeedV3Params, type SECFiling, type SECFilingsParams, type Screener, type ScreenerParams, type SenateHouseTradingByNameResponse, type SenateTradingResponse, type SharesFloat, type SplitsCalendar, type StockDividend, type StockDividendResponse, type StockList, type StockListResponse, type StockRealTimePrice, type StockRealTimePriceFull, type StockSplit, type StockSplitResponse, type SymbolParams, TransactionType, type TransactionTypesResponse, type TreasuryRate };
1334
+ export { type APIResponse, type Article, type AvailableCountries, type AvailableExchanges, type AvailableIndexesList, type AvailableIndustries, type AvailableSectors, type BalanceSheet, type BalanceSheetGrowth, type BeneficialOwnershipResponse, type CashFlowStatement, type CashflowGrowth, type CikMapperBySymbolResponse, type CikMapperResponse, type CompaniesPriceListResponse, type CompanyNotes, type CompanyProfile, type CompanyTranscriptData, type CryptoList, type DateRangeParams, type DividendsCalendar, type ETFCountryWeighting, type ETFHolder, type ETFHolding, type ETFHoldingDates, type ETFList, type ETFProfile, type ETFStockExposure, type ETFWeighting, type EarningsCalendar, type EarningsCallTranscript, type EarningsConfirmed, type EarningsHistorical, type EarningsSurprises, type EconomicIndicator, type EconomicIndicatorName, type EconomicsCalendar, type EnterpriseValue, Exchange, type ExecutiveCompensation, type FMPConfig, type FailToDeliverResponse, type FinancialGrowth, type FinancialRatios, type ForexList, type Form13FResponse, type HistoricalEmployeeCount, type HistoricalPriceData, type HistoricalPriceResponse, type HistoricalSharesFloat, type HouseTradingResponse, type IPOCalendar, type IncomeGrowth, type IncomeStatement, type IndividualIndustryClassificationParams, type IndustryClassification, type IndustryClassificationCode, type IndustryClassificationCodesParams, type InsiderTradeStatisticsResponse, type InsiderTradingRSSResponse, type InsiderTradingSearchResponse, type InsidersBySymbolResponse, type InstitutionalHolderResponse, type KeyMetrics, type MarketCap, type MarketHoliday, type MarketHours, type MarketIndex, type MarketPerformance, type MarketSectorPerformance, type MutualFundHolding, type News, type PaginationParams, Period, type PeriodParams, type QueryParams, type Quote, type RSSFeed8KItem, type RSSFeed8KParams, type RSSFeedAllItem, type RSSFeedItem, type RSSFeedParams, type RSSFeedV3Item, type RSSFeedV3Params, type SECFiling, type SECFilingsParams, type Screener, type ScreenerParams, type SenateHouseTradingByNameResponse, type SenateTradingResponse, type SharesFloat, type SplitsCalendar, type StockDividend, type StockDividendResponse, type StockList, type StockListResponse, type StockRealTimePrice, type StockRealTimePriceFull, type StockSplit, type StockSplitResponse, type SymbolParams, TransactionType, type TransactionTypesResponse, type TreasuryRate };
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/common.ts","../src/insider.ts"],"names":["Period","Exchange","TransactionType"],"mappings":";;;AAyCO,IAAK,MAAA,qBAAAA,OAAAA,KAAL;AACL,EAAAA,QAAA,QAAA,CAAA,GAAS,QAAA;AACT,EAAAA,QAAA,SAAA,CAAA,GAAU,SAAA;AAFA,EAAA,OAAAA,OAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA;AAKL,IAAK,QAAA,qBAAAC,SAAAA,KAAL;AACL,EAAAA,UAAA,MAAA,CAAA,GAAO,MAAA;AACP,EAAAA,UAAA,QAAA,CAAA,GAAS,QAAA;AACT,EAAAA,UAAA,MAAA,CAAA,GAAO,MAAA;AACP,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AARI,EAAA,OAAAA,SAAAA;AAAA,CAAA,EAAA,QAAA,IAAA,EAAA;;;ACsDL,IAAK,eAAA,qBAAAC,gBAAAA,KAAL;AACL,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,YAAA,CAAA,GAAa,cAAA;AACb,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,cAAA,CAAA,GAAe,eAAA;AACf,EAAAA,iBAAA,SAAA,CAAA,GAAU,UAAA;AACV,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,aAAA,CAAA,GAAc,cAAA;AACd,EAAAA,iBAAA,eAAA,CAAA,GAAgB,iBAAA;AAChB,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,kBAAA,CAAA,GAAmB,iBAAA;AACnB,EAAAA,iBAAA,UAAA,CAAA,GAAW,YAAA;AACX,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,cAAA,CAAA,GAAe,cAAA;AACf,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AAlBE,EAAA,OAAAA,gBAAAA;AAAA,CAAA,EAAA,eAAA,IAAA,EAAA","file":"index.js","sourcesContent":["// Common types used across all FMP API endpoints\n\n// Base API response wrapper - consistent structure with nullable fields\nexport interface APIResponse<T = unknown> {\n success: boolean;\n data: T | null;\n error: string | null;\n status: number;\n}\n\n// FMP API configuration\nexport interface FMPConfig {\n apiKey?: string; // Optional since we support FMP_API_KEY environment variable\n timeout?: number;\n}\n\n// Common parameter interfaces\nexport interface SymbolParams {\n symbol: string;\n}\n\nexport interface DateRangeParams {\n from?: string;\n to?: string;\n}\n\nexport interface PaginationParams {\n limit?: number;\n page?: number;\n}\n\nexport interface PeriodParams {\n period?: 'annual' | 'quarter';\n}\n\n// Type-safe query parameters\nexport interface QueryParams {\n [key: string]: string | number | boolean | undefined;\n}\n\n// Common enums\nexport enum Period {\n ANNUAL = 'annual',\n QUARTER = 'quarter',\n}\n\nexport enum Exchange {\n NYSE = 'NYSE',\n NASDAQ = 'NASDAQ',\n AMEX = 'AMEX',\n TSX = 'TSX',\n LSE = 'LSE',\n ASX = 'ASX',\n NSE = 'NSE',\n BSE = 'BSE',\n}\n","// Insider Trading Types\n\n// RSS Feed Response\nexport interface InsiderTradingRSSResponse {\n title: string;\n fillingDate: string;\n symbol: string;\n link: string;\n reportingCik: string;\n issuerCik: string;\n}\n\n// Insider Trading Search Response\nexport interface InsiderTradingSearchResponse {\n symbol: string;\n filingDate: string;\n transactionDate: string;\n reportingCik: string;\n transactionType: string;\n securitiesOwned: number;\n securitiesTransacted: number;\n companyCik: string;\n reportingName: string;\n typeOfOwner: string;\n link: string;\n securityName: string;\n price: number;\n formType: string;\n acquistionOrDisposition: string;\n}\n\n// Transaction Types Response\nexport type TransactionTypesResponse = string[];\n\n// Insiders By Symbol Response\nexport interface InsidersBySymbolResponse {\n typeOfOwner: string;\n transactionDate: string;\n owner: string;\n}\n\n// Insider Trade Statistics Response\nexport interface InsiderTradeStatisticsResponse {\n symbol: string;\n cik: string;\n year: number;\n quarter: number;\n purchases: number;\n sales: number;\n buySellRatio: number;\n totalBought: number;\n totalSold: number;\n averageBought: number;\n averageSold: number;\n pPurchases: number;\n sSales: number;\n}\n\n// CIK Mapper Response\nexport interface CikMapperResponse {\n reportingCik: string;\n reportingName: string;\n}\n\n// CIK Mapper By Symbol Response\nexport interface CikMapperBySymbolResponse {\n symbol: string;\n companyCik: string;\n}\n\n// Beneficial Ownership Response\nexport interface BeneficialOwnershipResponse {\n cik: string;\n symbol: string;\n filingDate: string;\n acceptedDate: string;\n cusip: string;\n nameOfReportingPerson: string;\n citizenshipOrPlaceOfOrganization: string;\n soleVotingPower: string;\n sharedVotingPower: string;\n soleDispositivePower: string;\n sharedDispositivePower: string;\n amountBeneficiallyOwned: string;\n percentOfClass: string;\n typeOfReportingPerson: string;\n url: string;\n}\n\n// Fail to Deliver Response\nexport interface FailToDeliverResponse {\n symbol: string;\n date: string;\n price: number;\n quantity: number;\n cusip: string;\n name: string;\n}\n\n// Transaction type enum for better type safety\nexport enum TransactionType {\n AWARD = 'A-Award',\n CONVERSION = 'C-Conversion',\n RETURN = 'D-Return',\n EXPIRE_SHORT = 'E-ExpireShort',\n IN_KIND = 'F-InKind',\n GIFT = 'G-Gift',\n EXPIRE_LONG = 'H-ExpireLong',\n DISCRETIONARY = 'I-Discretionary',\n OTHER = 'J-Other',\n SMALL = 'L-Small',\n EXEMPT = 'M-Exempt',\n OUT_OF_THE_MONEY = 'O-OutOfTheMoney',\n PURCHASE = 'P-Purchase',\n SALE = 'S-Sale',\n TENDER = 'U-Tender',\n WILL = 'W-Will',\n IN_THE_MONEY = 'X-InTheMoney',\n TRUST = 'Z-Trust',\n}\n"]}
1
+ {"version":3,"sources":["../src/common.ts","../src/insider.ts"],"names":["Period","Exchange","TransactionType"],"mappings":";;;AAyCO,IAAK,MAAA,qBAAAA,OAAAA,KAAL;AACL,EAAAA,QAAA,QAAA,CAAA,GAAS,QAAA;AACT,EAAAA,QAAA,SAAA,CAAA,GAAU,SAAA;AAFA,EAAA,OAAAA,OAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA;AAKL,IAAK,QAAA,qBAAAC,SAAAA,KAAL;AACL,EAAAA,UAAA,MAAA,CAAA,GAAO,MAAA;AACP,EAAAA,UAAA,QAAA,CAAA,GAAS,QAAA;AACT,EAAAA,UAAA,MAAA,CAAA,GAAO,MAAA;AACP,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AARI,EAAA,OAAAA,SAAAA;AAAA,CAAA,EAAA,QAAA,IAAA,EAAA;;;ACiEL,IAAK,eAAA,qBAAAC,gBAAAA,KAAL;AACL,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,YAAA,CAAA,GAAa,cAAA;AACb,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,cAAA,CAAA,GAAe,eAAA;AACf,EAAAA,iBAAA,SAAA,CAAA,GAAU,UAAA;AACV,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,aAAA,CAAA,GAAc,cAAA;AACd,EAAAA,iBAAA,eAAA,CAAA,GAAgB,iBAAA;AAChB,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,kBAAA,CAAA,GAAmB,iBAAA;AACnB,EAAAA,iBAAA,UAAA,CAAA,GAAW,YAAA;AACX,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,cAAA,CAAA,GAAe,cAAA;AACf,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AAlBE,EAAA,OAAAA,gBAAAA;AAAA,CAAA,EAAA,eAAA,IAAA,EAAA","file":"index.js","sourcesContent":["// Common types used across all FMP API endpoints\n\n// Base API response wrapper - consistent structure with nullable fields\nexport interface APIResponse<T = unknown> {\n success: boolean;\n data: T | null;\n error: string | null;\n status: number;\n}\n\n// FMP API configuration\nexport interface FMPConfig {\n apiKey?: string; // Optional since we support FMP_API_KEY environment variable\n timeout?: number;\n}\n\n// Common parameter interfaces\nexport interface SymbolParams {\n symbol: string;\n}\n\nexport interface DateRangeParams {\n from?: string;\n to?: string;\n}\n\nexport interface PaginationParams {\n limit?: number;\n page?: number;\n}\n\nexport interface PeriodParams {\n period?: 'annual' | 'quarter';\n}\n\n// Type-safe query parameters\nexport interface QueryParams {\n [key: string]: string | number | boolean | undefined;\n}\n\n// Common enums\nexport enum Period {\n ANNUAL = 'annual',\n QUARTER = 'quarter',\n}\n\nexport enum Exchange {\n NYSE = 'NYSE',\n NASDAQ = 'NASDAQ',\n AMEX = 'AMEX',\n TSX = 'TSX',\n LSE = 'LSE',\n ASX = 'ASX',\n NSE = 'NSE',\n BSE = 'BSE',\n}\n","// Insider Trading Types\n\n// RSS Feed Response\nexport interface InsiderTradingRSSResponse {\n symbol: string;\n filingDate: string;\n transactionDate: string;\n reportingCik: string;\n companyCik: string;\n transactionType: string;\n securitiesOwned: number;\n reportingName: string;\n typeOfOwner: string;\n acquisitionOrDisposition: string;\n directOrIndirect: string;\n formType: string;\n securitiesTransacted: number;\n price: number;\n securityName: string;\n url: string;\n}\n\n// Insider Trading Search Response\nexport interface InsiderTradingSearchResponse {\n symbol: string;\n filingDate: string;\n transactionDate: string;\n reportingCik: string;\n companyCik: string;\n transactionType: string;\n securitiesOwned: number;\n reportingName: string;\n typeOfOwner: string;\n acquisitionOrDisposition: string;\n directOrIndirect: string;\n formType: string;\n securitiesTransacted: number;\n price: number;\n securityName: string;\n url: string;\n}\n\n// Transaction Types Response\nexport type TransactionTypesResponse = { transactionType: string }[];\n\n// Insiders By Symbol Response\nexport interface InsidersBySymbolResponse {\n typeOfOwner: string;\n transactionDate: string;\n owner: string;\n}\n\n// Insider Trade Statistics Response\nexport interface InsiderTradeStatisticsResponse {\n symbol: string;\n cik: string;\n year: number;\n quarter: number;\n acquiredTransactions: number;\n disposedTransactions: number;\n acquiredDisposedRatio: number;\n totalAcquired: number;\n totalDisposed: number;\n averageAcquired: number;\n averageDisposed: number;\n totalPurchases: number;\n totalSales: number;\n}\n\n// CIK Mapper Response\nexport interface CikMapperResponse {\n reportingCik: string;\n reportingName: string;\n}\n\n// CIK Mapper By Symbol Response\nexport interface CikMapperBySymbolResponse {\n symbol: string;\n companyCik: string;\n}\n\n// Beneficial Ownership Response\nexport interface BeneficialOwnershipResponse {\n cik: string;\n symbol: string;\n filingDate: string;\n acceptedDate: string;\n cusip: string;\n nameOfReportingPerson: string;\n citizenshipOrPlaceOfOrganization: string;\n soleVotingPower: string;\n sharedVotingPower: string;\n soleDispositivePower: string;\n sharedDispositivePower: string;\n amountBeneficiallyOwned: string;\n percentOfClass: string;\n typeOfReportingPerson: string;\n url: string;\n}\n\n// Fail to Deliver Response\nexport interface FailToDeliverResponse {\n symbol: string;\n date: string;\n price: number;\n quantity: number;\n cusip: string;\n name: string;\n}\n\n// Transaction type enum for better type safety\nexport enum TransactionType {\n AWARD = 'A-Award',\n CONVERSION = 'C-Conversion',\n RETURN = 'D-Return',\n EXPIRE_SHORT = 'E-ExpireShort',\n IN_KIND = 'F-InKind',\n GIFT = 'G-Gift',\n EXPIRE_LONG = 'H-ExpireLong',\n DISCRETIONARY = 'I-Discretionary',\n OTHER = 'J-Other',\n SMALL = 'L-Small',\n EXEMPT = 'M-Exempt',\n OUT_OF_THE_MONEY = 'O-OutOfTheMoney',\n PURCHASE = 'P-Purchase',\n SALE = 'S-Sale',\n TENDER = 'U-Tender',\n WILL = 'W-Will',\n IN_THE_MONEY = 'X-InTheMoney',\n TRUST = 'Z-Trust',\n}\n"]}
package/dist/index.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/common.ts","../src/insider.ts"],"names":["Period","Exchange","TransactionType"],"mappings":";AAyCO,IAAK,MAAA,qBAAAA,OAAAA,KAAL;AACL,EAAAA,QAAA,QAAA,CAAA,GAAS,QAAA;AACT,EAAAA,QAAA,SAAA,CAAA,GAAU,SAAA;AAFA,EAAA,OAAAA,OAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA;AAKL,IAAK,QAAA,qBAAAC,SAAAA,KAAL;AACL,EAAAA,UAAA,MAAA,CAAA,GAAO,MAAA;AACP,EAAAA,UAAA,QAAA,CAAA,GAAS,QAAA;AACT,EAAAA,UAAA,MAAA,CAAA,GAAO,MAAA;AACP,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AARI,EAAA,OAAAA,SAAAA;AAAA,CAAA,EAAA,QAAA,IAAA,EAAA;;;ACsDL,IAAK,eAAA,qBAAAC,gBAAAA,KAAL;AACL,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,YAAA,CAAA,GAAa,cAAA;AACb,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,cAAA,CAAA,GAAe,eAAA;AACf,EAAAA,iBAAA,SAAA,CAAA,GAAU,UAAA;AACV,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,aAAA,CAAA,GAAc,cAAA;AACd,EAAAA,iBAAA,eAAA,CAAA,GAAgB,iBAAA;AAChB,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,kBAAA,CAAA,GAAmB,iBAAA;AACnB,EAAAA,iBAAA,UAAA,CAAA,GAAW,YAAA;AACX,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,cAAA,CAAA,GAAe,cAAA;AACf,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AAlBE,EAAA,OAAAA,gBAAAA;AAAA,CAAA,EAAA,eAAA,IAAA,EAAA","file":"index.mjs","sourcesContent":["// Common types used across all FMP API endpoints\n\n// Base API response wrapper - consistent structure with nullable fields\nexport interface APIResponse<T = unknown> {\n success: boolean;\n data: T | null;\n error: string | null;\n status: number;\n}\n\n// FMP API configuration\nexport interface FMPConfig {\n apiKey?: string; // Optional since we support FMP_API_KEY environment variable\n timeout?: number;\n}\n\n// Common parameter interfaces\nexport interface SymbolParams {\n symbol: string;\n}\n\nexport interface DateRangeParams {\n from?: string;\n to?: string;\n}\n\nexport interface PaginationParams {\n limit?: number;\n page?: number;\n}\n\nexport interface PeriodParams {\n period?: 'annual' | 'quarter';\n}\n\n// Type-safe query parameters\nexport interface QueryParams {\n [key: string]: string | number | boolean | undefined;\n}\n\n// Common enums\nexport enum Period {\n ANNUAL = 'annual',\n QUARTER = 'quarter',\n}\n\nexport enum Exchange {\n NYSE = 'NYSE',\n NASDAQ = 'NASDAQ',\n AMEX = 'AMEX',\n TSX = 'TSX',\n LSE = 'LSE',\n ASX = 'ASX',\n NSE = 'NSE',\n BSE = 'BSE',\n}\n","// Insider Trading Types\n\n// RSS Feed Response\nexport interface InsiderTradingRSSResponse {\n title: string;\n fillingDate: string;\n symbol: string;\n link: string;\n reportingCik: string;\n issuerCik: string;\n}\n\n// Insider Trading Search Response\nexport interface InsiderTradingSearchResponse {\n symbol: string;\n filingDate: string;\n transactionDate: string;\n reportingCik: string;\n transactionType: string;\n securitiesOwned: number;\n securitiesTransacted: number;\n companyCik: string;\n reportingName: string;\n typeOfOwner: string;\n link: string;\n securityName: string;\n price: number;\n formType: string;\n acquistionOrDisposition: string;\n}\n\n// Transaction Types Response\nexport type TransactionTypesResponse = string[];\n\n// Insiders By Symbol Response\nexport interface InsidersBySymbolResponse {\n typeOfOwner: string;\n transactionDate: string;\n owner: string;\n}\n\n// Insider Trade Statistics Response\nexport interface InsiderTradeStatisticsResponse {\n symbol: string;\n cik: string;\n year: number;\n quarter: number;\n purchases: number;\n sales: number;\n buySellRatio: number;\n totalBought: number;\n totalSold: number;\n averageBought: number;\n averageSold: number;\n pPurchases: number;\n sSales: number;\n}\n\n// CIK Mapper Response\nexport interface CikMapperResponse {\n reportingCik: string;\n reportingName: string;\n}\n\n// CIK Mapper By Symbol Response\nexport interface CikMapperBySymbolResponse {\n symbol: string;\n companyCik: string;\n}\n\n// Beneficial Ownership Response\nexport interface BeneficialOwnershipResponse {\n cik: string;\n symbol: string;\n filingDate: string;\n acceptedDate: string;\n cusip: string;\n nameOfReportingPerson: string;\n citizenshipOrPlaceOfOrganization: string;\n soleVotingPower: string;\n sharedVotingPower: string;\n soleDispositivePower: string;\n sharedDispositivePower: string;\n amountBeneficiallyOwned: string;\n percentOfClass: string;\n typeOfReportingPerson: string;\n url: string;\n}\n\n// Fail to Deliver Response\nexport interface FailToDeliverResponse {\n symbol: string;\n date: string;\n price: number;\n quantity: number;\n cusip: string;\n name: string;\n}\n\n// Transaction type enum for better type safety\nexport enum TransactionType {\n AWARD = 'A-Award',\n CONVERSION = 'C-Conversion',\n RETURN = 'D-Return',\n EXPIRE_SHORT = 'E-ExpireShort',\n IN_KIND = 'F-InKind',\n GIFT = 'G-Gift',\n EXPIRE_LONG = 'H-ExpireLong',\n DISCRETIONARY = 'I-Discretionary',\n OTHER = 'J-Other',\n SMALL = 'L-Small',\n EXEMPT = 'M-Exempt',\n OUT_OF_THE_MONEY = 'O-OutOfTheMoney',\n PURCHASE = 'P-Purchase',\n SALE = 'S-Sale',\n TENDER = 'U-Tender',\n WILL = 'W-Will',\n IN_THE_MONEY = 'X-InTheMoney',\n TRUST = 'Z-Trust',\n}\n"]}
1
+ {"version":3,"sources":["../src/common.ts","../src/insider.ts"],"names":["Period","Exchange","TransactionType"],"mappings":";AAyCO,IAAK,MAAA,qBAAAA,OAAAA,KAAL;AACL,EAAAA,QAAA,QAAA,CAAA,GAAS,QAAA;AACT,EAAAA,QAAA,SAAA,CAAA,GAAU,SAAA;AAFA,EAAA,OAAAA,OAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA;AAKL,IAAK,QAAA,qBAAAC,SAAAA,KAAL;AACL,EAAAA,UAAA,MAAA,CAAA,GAAO,MAAA;AACP,EAAAA,UAAA,QAAA,CAAA,GAAS,QAAA;AACT,EAAAA,UAAA,MAAA,CAAA,GAAO,MAAA;AACP,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AACN,EAAAA,UAAA,KAAA,CAAA,GAAM,KAAA;AARI,EAAA,OAAAA,SAAAA;AAAA,CAAA,EAAA,QAAA,IAAA,EAAA;;;ACiEL,IAAK,eAAA,qBAAAC,gBAAAA,KAAL;AACL,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,YAAA,CAAA,GAAa,cAAA;AACb,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,cAAA,CAAA,GAAe,eAAA;AACf,EAAAA,iBAAA,SAAA,CAAA,GAAU,UAAA;AACV,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,aAAA,CAAA,GAAc,cAAA;AACd,EAAAA,iBAAA,eAAA,CAAA,GAAgB,iBAAA;AAChB,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AACR,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,kBAAA,CAAA,GAAmB,iBAAA;AACnB,EAAAA,iBAAA,UAAA,CAAA,GAAW,YAAA;AACX,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,QAAA,CAAA,GAAS,UAAA;AACT,EAAAA,iBAAA,MAAA,CAAA,GAAO,QAAA;AACP,EAAAA,iBAAA,cAAA,CAAA,GAAe,cAAA;AACf,EAAAA,iBAAA,OAAA,CAAA,GAAQ,SAAA;AAlBE,EAAA,OAAAA,gBAAAA;AAAA,CAAA,EAAA,eAAA,IAAA,EAAA","file":"index.mjs","sourcesContent":["// Common types used across all FMP API endpoints\n\n// Base API response wrapper - consistent structure with nullable fields\nexport interface APIResponse<T = unknown> {\n success: boolean;\n data: T | null;\n error: string | null;\n status: number;\n}\n\n// FMP API configuration\nexport interface FMPConfig {\n apiKey?: string; // Optional since we support FMP_API_KEY environment variable\n timeout?: number;\n}\n\n// Common parameter interfaces\nexport interface SymbolParams {\n symbol: string;\n}\n\nexport interface DateRangeParams {\n from?: string;\n to?: string;\n}\n\nexport interface PaginationParams {\n limit?: number;\n page?: number;\n}\n\nexport interface PeriodParams {\n period?: 'annual' | 'quarter';\n}\n\n// Type-safe query parameters\nexport interface QueryParams {\n [key: string]: string | number | boolean | undefined;\n}\n\n// Common enums\nexport enum Period {\n ANNUAL = 'annual',\n QUARTER = 'quarter',\n}\n\nexport enum Exchange {\n NYSE = 'NYSE',\n NASDAQ = 'NASDAQ',\n AMEX = 'AMEX',\n TSX = 'TSX',\n LSE = 'LSE',\n ASX = 'ASX',\n NSE = 'NSE',\n BSE = 'BSE',\n}\n","// Insider Trading Types\n\n// RSS Feed Response\nexport interface InsiderTradingRSSResponse {\n symbol: string;\n filingDate: string;\n transactionDate: string;\n reportingCik: string;\n companyCik: string;\n transactionType: string;\n securitiesOwned: number;\n reportingName: string;\n typeOfOwner: string;\n acquisitionOrDisposition: string;\n directOrIndirect: string;\n formType: string;\n securitiesTransacted: number;\n price: number;\n securityName: string;\n url: string;\n}\n\n// Insider Trading Search Response\nexport interface InsiderTradingSearchResponse {\n symbol: string;\n filingDate: string;\n transactionDate: string;\n reportingCik: string;\n companyCik: string;\n transactionType: string;\n securitiesOwned: number;\n reportingName: string;\n typeOfOwner: string;\n acquisitionOrDisposition: string;\n directOrIndirect: string;\n formType: string;\n securitiesTransacted: number;\n price: number;\n securityName: string;\n url: string;\n}\n\n// Transaction Types Response\nexport type TransactionTypesResponse = { transactionType: string }[];\n\n// Insiders By Symbol Response\nexport interface InsidersBySymbolResponse {\n typeOfOwner: string;\n transactionDate: string;\n owner: string;\n}\n\n// Insider Trade Statistics Response\nexport interface InsiderTradeStatisticsResponse {\n symbol: string;\n cik: string;\n year: number;\n quarter: number;\n acquiredTransactions: number;\n disposedTransactions: number;\n acquiredDisposedRatio: number;\n totalAcquired: number;\n totalDisposed: number;\n averageAcquired: number;\n averageDisposed: number;\n totalPurchases: number;\n totalSales: number;\n}\n\n// CIK Mapper Response\nexport interface CikMapperResponse {\n reportingCik: string;\n reportingName: string;\n}\n\n// CIK Mapper By Symbol Response\nexport interface CikMapperBySymbolResponse {\n symbol: string;\n companyCik: string;\n}\n\n// Beneficial Ownership Response\nexport interface BeneficialOwnershipResponse {\n cik: string;\n symbol: string;\n filingDate: string;\n acceptedDate: string;\n cusip: string;\n nameOfReportingPerson: string;\n citizenshipOrPlaceOfOrganization: string;\n soleVotingPower: string;\n sharedVotingPower: string;\n soleDispositivePower: string;\n sharedDispositivePower: string;\n amountBeneficiallyOwned: string;\n percentOfClass: string;\n typeOfReportingPerson: string;\n url: string;\n}\n\n// Fail to Deliver Response\nexport interface FailToDeliverResponse {\n symbol: string;\n date: string;\n price: number;\n quantity: number;\n cusip: string;\n name: string;\n}\n\n// Transaction type enum for better type safety\nexport enum TransactionType {\n AWARD = 'A-Award',\n CONVERSION = 'C-Conversion',\n RETURN = 'D-Return',\n EXPIRE_SHORT = 'E-ExpireShort',\n IN_KIND = 'F-InKind',\n GIFT = 'G-Gift',\n EXPIRE_LONG = 'H-ExpireLong',\n DISCRETIONARY = 'I-Discretionary',\n OTHER = 'J-Other',\n SMALL = 'L-Small',\n EXEMPT = 'M-Exempt',\n OUT_OF_THE_MONEY = 'O-OutOfTheMoney',\n PURCHASE = 'P-Purchase',\n SALE = 'S-Sale',\n TENDER = 'U-Tender',\n WILL = 'W-Will',\n IN_THE_MONEY = 'X-InTheMoney',\n TRUST = 'Z-Trust',\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fmp-node-types",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "description": "Shared TypeScript types for FMP Node Wrapper ecosystem (internal package)",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",