-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtypes.ts
More file actions
253 lines (230 loc) · 5.47 KB
/
types.ts
File metadata and controls
253 lines (230 loc) · 5.47 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
// FMP API Response Types
export interface FmpProfile {
symbol: string;
price: number;
companyName: string;
sector: string;
industry: string;
description: string;
exchangeShortName: string;
marketCap: number;
dividendYield: number;
}
export interface FmpQuote {
price: number;
changesPercentage: number;
change: number;
yearLow: number;
yearHigh: number;
marketCap: number;
pe: number;
eps: number;
volume: number;
avgVolume: number;
}
export interface FmpIncomeStatement {
calendarYear: string;
revenue: number;
incomeBeforeTax: number;
netIncome: number;
weightedAverageShsOut: number;
eps: number;
epsDiluted?: number;
}
export interface FmpBalanceSheet {
calendarYear: string;
date: string;
totalStockholdersEquity: number;
totalDebt: number;
longTermDebt: number;
totalAssets: number;
cashAndCashEquivalents: number;
totalCurrentAssets: number;
totalCurrentLiabilities: number;
}
export interface FmpRatio {
calendarYear: string;
returnOnEquity: number;
payoutRatio: number;
interestCoverage: number;
currentRatio: number;
priceEarningsRatio: number;
dividendYield: number;
}
export interface FmpAnalystEstimate {
estimatedEpsAvg: number;
growthEstimationYear5: number; // Often used for LT growth
}
export interface FmpHistoricalPrice {
date: string;
close: number;
}
export interface FmpIntradayPrice {
date: string;
close: number;
}
export interface FmpScore {
altmanZScore: number;
piotroskiScore: number;
}
export interface FmpRevenueSegmentation {
fiscalYear: string;
data: {
[key: string]: number;
};
}
export interface FmpCashFlowStatement {
fiscalYear: string;
netIncome: number;
netCashProvidedByOperatingActivities: number;
netCashProvidedByInvestingActivities: number;
netCashProvidedByFinancingActivities: number;
capitalExpenditure: number;
debtRepayment: number;
}
export interface FmpKeyMetricsTTM {
peRatioTTM: number;
dividendYieldTTM: number;
payoutRatioTTM: number | null;
}
export interface FmpKeyMetrics {
calendarYear: string;
peRatio: number;
}
export interface FmpRawData {
profile: FmpProfile[];
quote: FmpQuote[];
income: FmpIncomeStatement[];
balance: FmpBalanceSheet[];
balanceQuarterly: FmpBalanceSheet[];
ratios: FmpRatio[];
estimates: FmpAnalystEstimate[];
score: FmpScore[];
revenueSegmentation: FmpRevenueSegmentation[];
cashFlow: FmpCashFlowStatement[];
keyMetrics: FmpKeyMetrics[];
keyMetricsTTM: FmpKeyMetricsTTM[];
}
export interface BalanceSheetDataPoint {
period: string;
totalAssets: number | null;
totalLiabilities: number | null;
totalEquity: number | null;
totalDebt: number | null;
longTermDebt: number | null;
cash: number | null;
currentRatio: number | null;
}
export interface ScoreCriterion {
criterion: string;
met: boolean;
value: string;
points: number;
}
export interface BuySellSignal {
signal: 'Strong Buy' | 'Buy' | 'Hold' | 'Consider Selling' | 'Strong Sell';
score: number;
growthScore: number;
healthScore: number;
valuationScore: number;
summary: string;
breakdown: {
growth: ScoreCriterion[];
health: ScoreCriterion[];
valuation: ScoreCriterion[];
};
}
// Data structures for new Financial Flows card
export interface RevenueStream {
year: string;
[segment: string]: number | string;
}
export interface CashFlowSummary {
year: string;
operating: number;
investing: number;
financing: number;
}
// Data structures for Growth Trends card
export interface GrowthTrendDataPoint {
year: string;
revenue: number;
eps: number;
}
export interface GrowthTrends {
periodLabel: string;
availableYears: number;
years: string[];
revenue: number[];
eps: number[];
sources: {
provider: string;
url: string;
fetchedAt: string;
}[];
revenueCagr5y: number | null;
revenueCagr10y: number | null;
epsCagr5y: number | null;
epsCagr10y: number | null;
cagrNotes: string[];
}
export interface ReturnForecast {
isDataSufficient: boolean;
currentPrice: number | null;
currentEps: number | null;
epsGrowthForecast: number | null; // as percentage
dividendYield: number | null; // as decimal
payoutRatio: number | null; // as decimal
historicalPeRatios: number[];
sources: { provider: string; url: string; fetchedAt: string }[];
}
// Application Data Structure
export interface ReportData {
ticker: string;
asOf: string;
snapshot: {
name: string;
sector: string;
industry: string;
exchange: string;
summary: string;
fullDescription: string;
marketCap: number | null;
dividendYieldPct: number | null;
};
growthQuality: {
salesCagr5Pct: number | null;
epsCagr5Pct: number | null;
preTaxMargin5yAvgPct: number | null;
roe5yAvgPct: number | null;
debtToCapitalPct: number | null;
};
financialHealth: {
piotroskiScore: number | null;
altmanZScore: number | null;
};
financialFlows: {
revenueStreams: RevenueStream[];
cashFlows: CashFlowSummary[];
};
balanceSheetHistory: {
annual: BalanceSheetDataPoint[];
quarterly: BalanceSheetDataPoint[];
};
valuation: {
price: number | null;
range52w: { low: number | null; high: number | null };
peCurrent: number | null;
pe5yAvg: number | null;
relativeValuePct: number | null;
};
flags: {
name: string;
ok: boolean;
note: string;
}[];
growthTrends: GrowthTrends;
returnForecast: ReturnForecast;
buySellSignal: BuySellSignal;
plainEnglish: string;
}