@budgetbuddyde/types 1.0.19 → 1.0.20

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 (3) hide show
  1. package/lib/Stock.types.d.ts +538 -199
  2. package/lib/Stock.types.js +54 -9
  3. package/package.json +1 -1
package/lib/Stock.types.d.ts CHANGED
@@ -1390,7 +1390,7 @@ export declare const ZAssetDetails: z.ZodObject<{
1390
1390
  ipoDate: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodDate, z.ZodNumber]>, z.ZodString]>, Date, string | number | Date>;
1391
1391
  etfDomicile: z.ZodString;
1392
1392
  etfCompany: z.ZodString;
1393
- hasDividends: z.ZodBoolean;
1393
+ hasDividends: z.ZodOptional<z.ZodBoolean>;
1394
1394
  }, "strip", z.ZodTypeAny, {
1395
1395
  type: string;
1396
1396
  website: string;
@@ -1419,7 +1419,7 @@ export declare const ZAssetDetails: z.ZodObject<{
1419
1419
  exchange: string;
1420
1420
  }[];
1421
1421
  ipoDate: Date;
1422
- hasDividends: boolean;
1422
+ hasDividends?: boolean | undefined;
1423
1423
  }, {
1424
1424
  type: string;
1425
1425
  website: string;
@@ -1448,7 +1448,7 @@ export declare const ZAssetDetails: z.ZodObject<{
1448
1448
  exchange: string;
1449
1449
  }[];
1450
1450
  ipoDate: (string | number | Date) & (string | number | Date | undefined);
1451
- hasDividends: boolean;
1451
+ hasDividends?: boolean | undefined;
1452
1452
  }>;
1453
1453
  }, "strip", z.ZodTypeAny, {
1454
1454
  name: string;
@@ -1487,7 +1487,7 @@ export declare const ZAssetDetails: z.ZodObject<{
1487
1487
  exchange: string;
1488
1488
  }[];
1489
1489
  ipoDate: Date;
1490
- hasDividends: boolean;
1490
+ hasDividends?: boolean | undefined;
1491
1491
  };
1492
1492
  updatedAt: Date;
1493
1493
  }, {
@@ -1527,7 +1527,7 @@ export declare const ZAssetDetails: z.ZodObject<{
1527
1527
  exchange: string;
1528
1528
  }[];
1529
1529
  ipoDate: (string | number | Date) & (string | number | Date | undefined);
1530
- hasDividends: boolean;
1530
+ hasDividends?: boolean | undefined;
1531
1531
  };
1532
1532
  updatedAt: (string | number | Date) & (string | number | Date | undefined);
1533
1533
  }>;
@@ -1557,7 +1557,7 @@ export declare const ZAssetDetails: z.ZodObject<{
1557
1557
  cachedAt: (string | number | Date) & (string | number | Date | undefined);
1558
1558
  }>;
1559
1559
  details: z.ZodObject<{
1560
- securityDetails: z.ZodObject<{
1560
+ securityDetails: z.ZodOptional<z.ZodObject<{
1561
1561
  description: z.ZodString;
1562
1562
  currency: z.ZodString;
1563
1563
  marketCap: z.ZodNumber;
@@ -1750,8 +1750,207 @@ export declare const ZAssetDetails: z.ZodObject<{
1750
1750
  ebitda: number;
1751
1751
  }[];
1752
1752
  ceo: string;
1753
- }>;
1754
- etfBreakdown: z.ZodNull;
1753
+ }>>;
1754
+ eftDetails: z.ZodOptional<z.ZodObject<{
1755
+ currency: z.ZodString;
1756
+ nav: z.ZodNumber;
1757
+ description: z.ZodString;
1758
+ priceToBook: z.ZodNumber;
1759
+ priceToEarnings: z.ZodNumber;
1760
+ aum: z.ZodNumber;
1761
+ expenseRatio: z.ZodNumber;
1762
+ }, "strip", z.ZodTypeAny, {
1763
+ nav: number;
1764
+ description: string;
1765
+ currency: string;
1766
+ priceToBook: number;
1767
+ priceToEarnings: number;
1768
+ aum: number;
1769
+ expenseRatio: number;
1770
+ }, {
1771
+ nav: number;
1772
+ description: string;
1773
+ currency: string;
1774
+ priceToBook: number;
1775
+ priceToEarnings: number;
1776
+ aum: number;
1777
+ expenseRatio: number;
1778
+ }>>;
1779
+ etfBreakdown: z.ZodOptional<z.ZodNullable<z.ZodObject<{
1780
+ currency: z.ZodString;
1781
+ updatedAt: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodDate, z.ZodNumber]>, z.ZodString]>, Date, string | number | Date>;
1782
+ holdings: z.ZodArray<z.ZodObject<{
1783
+ share: z.ZodNumber;
1784
+ marketValue: z.ZodNumber;
1785
+ amountOfShares: z.ZodNumber;
1786
+ name: z.ZodString;
1787
+ asset: z.ZodObject<{
1788
+ _id: z.ZodObject<{
1789
+ identifier: z.ZodString;
1790
+ assetType: z.ZodString;
1791
+ }, "strip", z.ZodTypeAny, {
1792
+ identifier: string;
1793
+ assetType: string;
1794
+ }, {
1795
+ identifier: string;
1796
+ assetType: string;
1797
+ }>;
1798
+ assetType: z.ZodString;
1799
+ name: z.ZodString;
1800
+ logo: z.ZodString;
1801
+ security: z.ZodObject<{
1802
+ website: z.ZodString;
1803
+ type: z.ZodString;
1804
+ wkn: z.ZodString;
1805
+ isin: z.ZodString;
1806
+ etfDomicile: z.ZodString;
1807
+ etfCompany: z.ZodString;
1808
+ }, "strip", z.ZodTypeAny, {
1809
+ type: string;
1810
+ website: string;
1811
+ wkn: string;
1812
+ isin: string;
1813
+ etfDomicile: string;
1814
+ etfCompany: string;
1815
+ }, {
1816
+ type: string;
1817
+ website: string;
1818
+ wkn: string;
1819
+ isin: string;
1820
+ etfDomicile: string;
1821
+ etfCompany: string;
1822
+ }>;
1823
+ }, "strip", z.ZodTypeAny, {
1824
+ name: string;
1825
+ _id: {
1826
+ identifier: string;
1827
+ assetType: string;
1828
+ };
1829
+ assetType: string;
1830
+ logo: string;
1831
+ security: {
1832
+ type: string;
1833
+ website: string;
1834
+ wkn: string;
1835
+ isin: string;
1836
+ etfDomicile: string;
1837
+ etfCompany: string;
1838
+ };
1839
+ }, {
1840
+ name: string;
1841
+ _id: {
1842
+ identifier: string;
1843
+ assetType: string;
1844
+ };
1845
+ assetType: string;
1846
+ logo: string;
1847
+ security: {
1848
+ type: string;
1849
+ website: string;
1850
+ wkn: string;
1851
+ isin: string;
1852
+ etfDomicile: string;
1853
+ etfCompany: string;
1854
+ };
1855
+ }>;
1856
+ }, "strip", z.ZodTypeAny, {
1857
+ name: string;
1858
+ asset: {
1859
+ name: string;
1860
+ _id: {
1861
+ identifier: string;
1862
+ assetType: string;
1863
+ };
1864
+ assetType: string;
1865
+ logo: string;
1866
+ security: {
1867
+ type: string;
1868
+ website: string;
1869
+ wkn: string;
1870
+ isin: string;
1871
+ etfDomicile: string;
1872
+ etfCompany: string;
1873
+ };
1874
+ };
1875
+ share: number;
1876
+ marketValue: number;
1877
+ amountOfShares: number;
1878
+ }, {
1879
+ name: string;
1880
+ asset: {
1881
+ name: string;
1882
+ _id: {
1883
+ identifier: string;
1884
+ assetType: string;
1885
+ };
1886
+ assetType: string;
1887
+ logo: string;
1888
+ security: {
1889
+ type: string;
1890
+ website: string;
1891
+ wkn: string;
1892
+ isin: string;
1893
+ etfDomicile: string;
1894
+ etfCompany: string;
1895
+ };
1896
+ };
1897
+ share: number;
1898
+ marketValue: number;
1899
+ amountOfShares: number;
1900
+ }>, "many">;
1901
+ }, "strip", z.ZodTypeAny, {
1902
+ currency: string;
1903
+ updatedAt: Date;
1904
+ holdings: {
1905
+ name: string;
1906
+ asset: {
1907
+ name: string;
1908
+ _id: {
1909
+ identifier: string;
1910
+ assetType: string;
1911
+ };
1912
+ assetType: string;
1913
+ logo: string;
1914
+ security: {
1915
+ type: string;
1916
+ website: string;
1917
+ wkn: string;
1918
+ isin: string;
1919
+ etfDomicile: string;
1920
+ etfCompany: string;
1921
+ };
1922
+ };
1923
+ share: number;
1924
+ marketValue: number;
1925
+ amountOfShares: number;
1926
+ }[];
1927
+ }, {
1928
+ currency: string;
1929
+ updatedAt: (string | number | Date) & (string | number | Date | undefined);
1930
+ holdings: {
1931
+ name: string;
1932
+ asset: {
1933
+ name: string;
1934
+ _id: {
1935
+ identifier: string;
1936
+ assetType: string;
1937
+ };
1938
+ assetType: string;
1939
+ logo: string;
1940
+ security: {
1941
+ type: string;
1942
+ website: string;
1943
+ wkn: string;
1944
+ isin: string;
1945
+ etfDomicile: string;
1946
+ etfCompany: string;
1947
+ };
1948
+ };
1949
+ share: number;
1950
+ marketValue: number;
1951
+ amountOfShares: number;
1952
+ }[];
1953
+ }>>>;
1755
1954
  analystEstimates: z.ZodNullable<z.ZodObject<{
1756
1955
  strongBuy: z.ZodNumber;
1757
1956
  buy: z.ZodNumber;
@@ -1961,9 +2160,9 @@ export declare const ZAssetDetails: z.ZodObject<{
1961
2160
  maxValue: number;
1962
2161
  badgeColor: string;
1963
2162
  }>, "many">;
1964
- payoutInterval: z.ZodString;
1965
- payoutIntervalSource: z.ZodString;
1966
- dividendKPIs: z.ZodObject<{
2163
+ payoutInterval: z.ZodNullable<z.ZodString>;
2164
+ payoutIntervalSource: z.ZodNullable<z.ZodString>;
2165
+ dividendKPIs: z.ZodOptional<z.ZodNullable<z.ZodObject<{
1967
2166
  cagr3Y: z.ZodNumber;
1968
2167
  cagr5Y: z.ZodNumber;
1969
2168
  cagr10Y: z.ZodNumber;
@@ -1981,10 +2180,10 @@ export declare const ZAssetDetails: z.ZodObject<{
1981
2180
  cagr10Y: number;
1982
2181
  dividendYieldPercentageTTM: number;
1983
2182
  dividendPerShareTTM: number;
1984
- }>;
1985
- dividendYearlyTTM: z.ZodRecord<z.ZodString, z.ZodNumber>;
2183
+ }>>>;
2184
+ dividendYearlyTTM: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodNumber>>;
1986
2185
  }, "strip", z.ZodTypeAny, {
1987
- payoutInterval: string;
2186
+ payoutInterval: string | null;
1988
2187
  futureDividends: {
1989
2188
  type: string;
1990
2189
  currency: string;
@@ -2000,62 +2199,6 @@ export declare const ZAssetDetails: z.ZodObject<{
2000
2199
  declarationDate?: Date | null | undefined;
2001
2200
  recordDate?: Date | null | undefined;
2002
2201
  }[] | null;
2003
- dividendKPIs: {
2004
- cagr3Y: number;
2005
- cagr5Y: number;
2006
- cagr10Y: number;
2007
- dividendYieldPercentageTTM: number;
2008
- dividendPerShareTTM: number;
2009
- };
2010
- securityDetails: {
2011
- beta: number;
2012
- address: {
2013
- state: string;
2014
- addressLine: string;
2015
- city: string;
2016
- zip: string;
2017
- };
2018
- description: string;
2019
- currency: string;
2020
- dividendPerShareTTM: number;
2021
- marketCap: number;
2022
- shares: number;
2023
- fullTimeEmployees: number;
2024
- peRatioTTM: number;
2025
- priceSalesRatioTTM: number;
2026
- priceToBookRatioTTM: number;
2027
- pegRatioTTM: number;
2028
- priceFairValueTTM: number;
2029
- dividendYielPercentageTTM: number;
2030
- payoutRatioTTM: number;
2031
- fiftyTwoWeekRange: {
2032
- from: number;
2033
- to: number;
2034
- };
2035
- incomeStatementGrowth: {
2036
- date: Date;
2037
- growthRevenue: number;
2038
- growthNetIncome: number;
2039
- }[];
2040
- annualFinancials: {
2041
- currency: string;
2042
- date: Date;
2043
- revenue: number;
2044
- grossProfit: number;
2045
- netIncome: number;
2046
- ebitda: number;
2047
- }[];
2048
- quarterlyFinancials: {
2049
- currency: string;
2050
- date: Date;
2051
- revenue: number;
2052
- grossProfit: number;
2053
- netIncome: number;
2054
- ebitda: number;
2055
- }[];
2056
- ceo: string;
2057
- };
2058
- etfBreakdown: null;
2059
2202
  analystEstimates: {
2060
2203
  strongBuy: number;
2061
2204
  buy: number;
@@ -2110,18 +2253,9 @@ export declare const ZAssetDetails: z.ZodObject<{
2110
2253
  maxValue: number;
2111
2254
  badgeColor: string;
2112
2255
  }[];
2113
- payoutIntervalSource: string;
2114
- dividendYearlyTTM: Record<string, number>;
2115
- }, {
2116
- payoutInterval: string;
2117
- dividendKPIs: {
2118
- cagr3Y: number;
2119
- cagr5Y: number;
2120
- cagr10Y: number;
2121
- dividendYieldPercentageTTM: number;
2122
- dividendPerShareTTM: number;
2123
- };
2124
- securityDetails: {
2256
+ payoutIntervalSource: string | null;
2257
+ dividendYearlyTTM: Record<string, number> | null;
2258
+ securityDetails?: {
2125
2259
  beta: number;
2126
2260
  address: {
2127
2261
  state: string;
@@ -2147,13 +2281,13 @@ export declare const ZAssetDetails: z.ZodObject<{
2147
2281
  to: number;
2148
2282
  };
2149
2283
  incomeStatementGrowth: {
2150
- date: (string | number | Date) & (string | number | Date | undefined);
2284
+ date: Date;
2151
2285
  growthRevenue: number;
2152
2286
  growthNetIncome: number;
2153
2287
  }[];
2154
2288
  annualFinancials: {
2155
2289
  currency: string;
2156
- date: (string | number | Date) & (string | number | Date | undefined);
2290
+ date: Date;
2157
2291
  revenue: number;
2158
2292
  grossProfit: number;
2159
2293
  netIncome: number;
@@ -2161,15 +2295,59 @@ export declare const ZAssetDetails: z.ZodObject<{
2161
2295
  }[];
2162
2296
  quarterlyFinancials: {
2163
2297
  currency: string;
2164
- date: (string | number | Date) & (string | number | Date | undefined);
2298
+ date: Date;
2165
2299
  revenue: number;
2166
2300
  grossProfit: number;
2167
2301
  netIncome: number;
2168
2302
  ebitda: number;
2169
2303
  }[];
2170
2304
  ceo: string;
2171
- };
2172
- etfBreakdown: null;
2305
+ } | undefined;
2306
+ eftDetails?: {
2307
+ nav: number;
2308
+ description: string;
2309
+ currency: string;
2310
+ priceToBook: number;
2311
+ priceToEarnings: number;
2312
+ aum: number;
2313
+ expenseRatio: number;
2314
+ } | undefined;
2315
+ etfBreakdown?: {
2316
+ currency: string;
2317
+ updatedAt: Date;
2318
+ holdings: {
2319
+ name: string;
2320
+ asset: {
2321
+ name: string;
2322
+ _id: {
2323
+ identifier: string;
2324
+ assetType: string;
2325
+ };
2326
+ assetType: string;
2327
+ logo: string;
2328
+ security: {
2329
+ type: string;
2330
+ website: string;
2331
+ wkn: string;
2332
+ isin: string;
2333
+ etfDomicile: string;
2334
+ etfCompany: string;
2335
+ };
2336
+ };
2337
+ share: number;
2338
+ marketValue: number;
2339
+ amountOfShares: number;
2340
+ }[];
2341
+ } | null | undefined;
2342
+ dividendKPIs?: {
2343
+ cagr3Y: number;
2344
+ cagr5Y: number;
2345
+ cagr10Y: number;
2346
+ dividendYieldPercentageTTM: number;
2347
+ dividendPerShareTTM: number;
2348
+ } | null | undefined;
2349
+ }, {
2350
+ payoutInterval: string | null;
2173
2351
  analystEstimates: {
2174
2352
  strongBuy: number;
2175
2353
  buy: number;
@@ -2209,8 +2387,92 @@ export declare const ZAssetDetails: z.ZodObject<{
2209
2387
  maxValue: number;
2210
2388
  badgeColor: string;
2211
2389
  }[];
2212
- payoutIntervalSource: string;
2213
- dividendYearlyTTM: Record<string, number>;
2390
+ payoutIntervalSource: string | null;
2391
+ dividendYearlyTTM: Record<string, number> | null;
2392
+ securityDetails?: {
2393
+ beta: number;
2394
+ address: {
2395
+ state: string;
2396
+ addressLine: string;
2397
+ city: string;
2398
+ zip: string;
2399
+ };
2400
+ description: string;
2401
+ currency: string;
2402
+ dividendPerShareTTM: number;
2403
+ marketCap: number;
2404
+ shares: number;
2405
+ fullTimeEmployees: number;
2406
+ peRatioTTM: number;
2407
+ priceSalesRatioTTM: number;
2408
+ priceToBookRatioTTM: number;
2409
+ pegRatioTTM: number;
2410
+ priceFairValueTTM: number;
2411
+ dividendYielPercentageTTM: number;
2412
+ payoutRatioTTM: number;
2413
+ fiftyTwoWeekRange: {
2414
+ from: number;
2415
+ to: number;
2416
+ };
2417
+ incomeStatementGrowth: {
2418
+ date: (string | number | Date) & (string | number | Date | undefined);
2419
+ growthRevenue: number;
2420
+ growthNetIncome: number;
2421
+ }[];
2422
+ annualFinancials: {
2423
+ currency: string;
2424
+ date: (string | number | Date) & (string | number | Date | undefined);
2425
+ revenue: number;
2426
+ grossProfit: number;
2427
+ netIncome: number;
2428
+ ebitda: number;
2429
+ }[];
2430
+ quarterlyFinancials: {
2431
+ currency: string;
2432
+ date: (string | number | Date) & (string | number | Date | undefined);
2433
+ revenue: number;
2434
+ grossProfit: number;
2435
+ netIncome: number;
2436
+ ebitda: number;
2437
+ }[];
2438
+ ceo: string;
2439
+ } | undefined;
2440
+ eftDetails?: {
2441
+ nav: number;
2442
+ description: string;
2443
+ currency: string;
2444
+ priceToBook: number;
2445
+ priceToEarnings: number;
2446
+ aum: number;
2447
+ expenseRatio: number;
2448
+ } | undefined;
2449
+ etfBreakdown?: {
2450
+ currency: string;
2451
+ updatedAt: (string | number | Date) & (string | number | Date | undefined);
2452
+ holdings: {
2453
+ name: string;
2454
+ asset: {
2455
+ name: string;
2456
+ _id: {
2457
+ identifier: string;
2458
+ assetType: string;
2459
+ };
2460
+ assetType: string;
2461
+ logo: string;
2462
+ security: {
2463
+ type: string;
2464
+ website: string;
2465
+ wkn: string;
2466
+ isin: string;
2467
+ etfDomicile: string;
2468
+ etfCompany: string;
2469
+ };
2470
+ };
2471
+ share: number;
2472
+ marketValue: number;
2473
+ amountOfShares: number;
2474
+ }[];
2475
+ } | null | undefined;
2214
2476
  historicalDividends?: {
2215
2477
  type: string;
2216
2478
  currency: string;
@@ -2241,10 +2503,17 @@ export declare const ZAssetDetails: z.ZodObject<{
2241
2503
  declarationDate?: string | number | Date | null | undefined;
2242
2504
  recordDate?: string | number | Date | null | undefined;
2243
2505
  }[] | null | undefined;
2506
+ dividendKPIs?: {
2507
+ cagr3Y: number;
2508
+ cagr5Y: number;
2509
+ cagr10Y: number;
2510
+ dividendYieldPercentageTTM: number;
2511
+ dividendPerShareTTM: number;
2512
+ } | null | undefined;
2244
2513
  }>;
2245
2514
  }, "strip", z.ZodTypeAny, {
2246
2515
  details: {
2247
- payoutInterval: string;
2516
+ payoutInterval: string | null;
2248
2517
  futureDividends: {
2249
2518
  type: string;
2250
2519
  currency: string;
@@ -2260,62 +2529,6 @@ export declare const ZAssetDetails: z.ZodObject<{
2260
2529
  declarationDate?: Date | null | undefined;
2261
2530
  recordDate?: Date | null | undefined;
2262
2531
  }[] | null;
2263
- dividendKPIs: {
2264
- cagr3Y: number;
2265
- cagr5Y: number;
2266
- cagr10Y: number;
2267
- dividendYieldPercentageTTM: number;
2268
- dividendPerShareTTM: number;
2269
- };
2270
- securityDetails: {
2271
- beta: number;
2272
- address: {
2273
- state: string;
2274
- addressLine: string;
2275
- city: string;
2276
- zip: string;
2277
- };
2278
- description: string;
2279
- currency: string;
2280
- dividendPerShareTTM: number;
2281
- marketCap: number;
2282
- shares: number;
2283
- fullTimeEmployees: number;
2284
- peRatioTTM: number;
2285
- priceSalesRatioTTM: number;
2286
- priceToBookRatioTTM: number;
2287
- pegRatioTTM: number;
2288
- priceFairValueTTM: number;
2289
- dividendYielPercentageTTM: number;
2290
- payoutRatioTTM: number;
2291
- fiftyTwoWeekRange: {
2292
- from: number;
2293
- to: number;
2294
- };
2295
- incomeStatementGrowth: {
2296
- date: Date;
2297
- growthRevenue: number;
2298
- growthNetIncome: number;
2299
- }[];
2300
- annualFinancials: {
2301
- currency: string;
2302
- date: Date;
2303
- revenue: number;
2304
- grossProfit: number;
2305
- netIncome: number;
2306
- ebitda: number;
2307
- }[];
2308
- quarterlyFinancials: {
2309
- currency: string;
2310
- date: Date;
2311
- revenue: number;
2312
- grossProfit: number;
2313
- netIncome: number;
2314
- ebitda: number;
2315
- }[];
2316
- ceo: string;
2317
- };
2318
- etfBreakdown: null;
2319
2532
  analystEstimates: {
2320
2533
  strongBuy: number;
2321
2534
  buy: number;
@@ -2370,8 +2583,99 @@ export declare const ZAssetDetails: z.ZodObject<{
2370
2583
  maxValue: number;
2371
2584
  badgeColor: string;
2372
2585
  }[];
2373
- payoutIntervalSource: string;
2374
- dividendYearlyTTM: Record<string, number>;
2586
+ payoutIntervalSource: string | null;
2587
+ dividendYearlyTTM: Record<string, number> | null;
2588
+ securityDetails?: {
2589
+ beta: number;
2590
+ address: {
2591
+ state: string;
2592
+ addressLine: string;
2593
+ city: string;
2594
+ zip: string;
2595
+ };
2596
+ description: string;
2597
+ currency: string;
2598
+ dividendPerShareTTM: number;
2599
+ marketCap: number;
2600
+ shares: number;
2601
+ fullTimeEmployees: number;
2602
+ peRatioTTM: number;
2603
+ priceSalesRatioTTM: number;
2604
+ priceToBookRatioTTM: number;
2605
+ pegRatioTTM: number;
2606
+ priceFairValueTTM: number;
2607
+ dividendYielPercentageTTM: number;
2608
+ payoutRatioTTM: number;
2609
+ fiftyTwoWeekRange: {
2610
+ from: number;
2611
+ to: number;
2612
+ };
2613
+ incomeStatementGrowth: {
2614
+ date: Date;
2615
+ growthRevenue: number;
2616
+ growthNetIncome: number;
2617
+ }[];
2618
+ annualFinancials: {
2619
+ currency: string;
2620
+ date: Date;
2621
+ revenue: number;
2622
+ grossProfit: number;
2623
+ netIncome: number;
2624
+ ebitda: number;
2625
+ }[];
2626
+ quarterlyFinancials: {
2627
+ currency: string;
2628
+ date: Date;
2629
+ revenue: number;
2630
+ grossProfit: number;
2631
+ netIncome: number;
2632
+ ebitda: number;
2633
+ }[];
2634
+ ceo: string;
2635
+ } | undefined;
2636
+ eftDetails?: {
2637
+ nav: number;
2638
+ description: string;
2639
+ currency: string;
2640
+ priceToBook: number;
2641
+ priceToEarnings: number;
2642
+ aum: number;
2643
+ expenseRatio: number;
2644
+ } | undefined;
2645
+ etfBreakdown?: {
2646
+ currency: string;
2647
+ updatedAt: Date;
2648
+ holdings: {
2649
+ name: string;
2650
+ asset: {
2651
+ name: string;
2652
+ _id: {
2653
+ identifier: string;
2654
+ assetType: string;
2655
+ };
2656
+ assetType: string;
2657
+ logo: string;
2658
+ security: {
2659
+ type: string;
2660
+ website: string;
2661
+ wkn: string;
2662
+ isin: string;
2663
+ etfDomicile: string;
2664
+ etfCompany: string;
2665
+ };
2666
+ };
2667
+ share: number;
2668
+ marketValue: number;
2669
+ amountOfShares: number;
2670
+ }[];
2671
+ } | null | undefined;
2672
+ dividendKPIs?: {
2673
+ cagr3Y: number;
2674
+ cagr5Y: number;
2675
+ cagr10Y: number;
2676
+ dividendYieldPercentageTTM: number;
2677
+ dividendPerShareTTM: number;
2678
+ } | null | undefined;
2375
2679
  };
2376
2680
  asset: {
2377
2681
  name: string;
@@ -2410,7 +2714,7 @@ export declare const ZAssetDetails: z.ZodObject<{
2410
2714
  exchange: string;
2411
2715
  }[];
2412
2716
  ipoDate: Date;
2413
- hasDividends: boolean;
2717
+ hasDividends?: boolean | undefined;
2414
2718
  };
2415
2719
  updatedAt: Date;
2416
2720
  };
@@ -2425,15 +2729,49 @@ export declare const ZAssetDetails: z.ZodObject<{
2425
2729
  };
2426
2730
  }, {
2427
2731
  details: {
2428
- payoutInterval: string;
2429
- dividendKPIs: {
2430
- cagr3Y: number;
2431
- cagr5Y: number;
2432
- cagr10Y: number;
2433
- dividendYieldPercentageTTM: number;
2434
- dividendPerShareTTM: number;
2732
+ payoutInterval: string | null;
2733
+ analystEstimates: {
2734
+ strongBuy: number;
2735
+ buy: number;
2736
+ hold: number;
2737
+ sell: number;
2738
+ strongSell: number;
2739
+ } | null;
2740
+ priceTargetConsensus: {
2741
+ high: number;
2742
+ low: number;
2743
+ currency: string;
2744
+ consensus: number;
2745
+ median: number;
2746
+ } | null;
2747
+ analysis: {
2748
+ entries: {
2749
+ url: string;
2750
+ title: string;
2751
+ analysisDate: (string | number | Date) & (string | number | Date | undefined);
2752
+ mediaType: string;
2753
+ ratingCount: number;
2754
+ rating: number;
2755
+ author: string;
2756
+ }[];
2435
2757
  };
2436
- securityDetails: {
2758
+ news: {
2759
+ url: string;
2760
+ title: string;
2761
+ image: string;
2762
+ description: string;
2763
+ publishedAt: (string | number | Date) & (string | number | Date | undefined);
2764
+ }[];
2765
+ scorings: {
2766
+ type: string;
2767
+ source: string;
2768
+ value: number;
2769
+ maxValue: number;
2770
+ badgeColor: string;
2771
+ }[];
2772
+ payoutIntervalSource: string | null;
2773
+ dividendYearlyTTM: Record<string, number> | null;
2774
+ securityDetails?: {
2437
2775
  beta: number;
2438
2776
  address: {
2439
2777
  state: string;
@@ -2480,49 +2818,43 @@ export declare const ZAssetDetails: z.ZodObject<{
2480
2818
  ebitda: number;
2481
2819
  }[];
2482
2820
  ceo: string;
2483
- };
2484
- etfBreakdown: null;
2485
- analystEstimates: {
2486
- strongBuy: number;
2487
- buy: number;
2488
- hold: number;
2489
- sell: number;
2490
- strongSell: number;
2491
- } | null;
2492
- priceTargetConsensus: {
2493
- high: number;
2494
- low: number;
2821
+ } | undefined;
2822
+ eftDetails?: {
2823
+ nav: number;
2824
+ description: string;
2495
2825
  currency: string;
2496
- consensus: number;
2497
- median: number;
2498
- } | null;
2499
- analysis: {
2500
- entries: {
2501
- url: string;
2502
- title: string;
2503
- analysisDate: (string | number | Date) & (string | number | Date | undefined);
2504
- mediaType: string;
2505
- ratingCount: number;
2506
- rating: number;
2507
- author: string;
2826
+ priceToBook: number;
2827
+ priceToEarnings: number;
2828
+ aum: number;
2829
+ expenseRatio: number;
2830
+ } | undefined;
2831
+ etfBreakdown?: {
2832
+ currency: string;
2833
+ updatedAt: (string | number | Date) & (string | number | Date | undefined);
2834
+ holdings: {
2835
+ name: string;
2836
+ asset: {
2837
+ name: string;
2838
+ _id: {
2839
+ identifier: string;
2840
+ assetType: string;
2841
+ };
2842
+ assetType: string;
2843
+ logo: string;
2844
+ security: {
2845
+ type: string;
2846
+ website: string;
2847
+ wkn: string;
2848
+ isin: string;
2849
+ etfDomicile: string;
2850
+ etfCompany: string;
2851
+ };
2852
+ };
2853
+ share: number;
2854
+ marketValue: number;
2855
+ amountOfShares: number;
2508
2856
  }[];
2509
- };
2510
- news: {
2511
- url: string;
2512
- title: string;
2513
- image: string;
2514
- description: string;
2515
- publishedAt: (string | number | Date) & (string | number | Date | undefined);
2516
- }[];
2517
- scorings: {
2518
- type: string;
2519
- source: string;
2520
- value: number;
2521
- maxValue: number;
2522
- badgeColor: string;
2523
- }[];
2524
- payoutIntervalSource: string;
2525
- dividendYearlyTTM: Record<string, number>;
2857
+ } | null | undefined;
2526
2858
  historicalDividends?: {
2527
2859
  type: string;
2528
2860
  currency: string;
@@ -2553,6 +2885,13 @@ export declare const ZAssetDetails: z.ZodObject<{
2553
2885
  declarationDate?: string | number | Date | null | undefined;
2554
2886
  recordDate?: string | number | Date | null | undefined;
2555
2887
  }[] | null | undefined;
2888
+ dividendKPIs?: {
2889
+ cagr3Y: number;
2890
+ cagr5Y: number;
2891
+ cagr10Y: number;
2892
+ dividendYieldPercentageTTM: number;
2893
+ dividendPerShareTTM: number;
2894
+ } | null | undefined;
2556
2895
  };
2557
2896
  asset: {
2558
2897
  name: string;
@@ -2591,7 +2930,7 @@ export declare const ZAssetDetails: z.ZodObject<{
2591
2930
  exchange: string;
2592
2931
  }[];
2593
2932
  ipoDate: (string | number | Date) & (string | number | Date | undefined);
2594
- hasDividends: boolean;
2933
+ hasDividends?: boolean | undefined;
2595
2934
  };
2596
2935
  updatedAt: (string | number | Date) & (string | number | Date | undefined);
2597
2936
  };
package/lib/Stock.types.js CHANGED
@@ -268,12 +268,13 @@ exports.ZAssetDetails = zod_1.z.object({
268
268
  ipoDate: Base_type_1.ZDate,
269
269
  etfDomicile: zod_1.z.string(),
270
270
  etfCompany: zod_1.z.string(),
271
- hasDividends: zod_1.z.boolean(),
271
+ hasDividends: zod_1.z.boolean().optional(),
272
272
  }),
273
273
  }),
274
274
  quote: exports.ZStockQuote,
275
275
  details: zod_1.z.object({
276
- securityDetails: zod_1.z.object({
276
+ securityDetails: zod_1.z
277
+ .object({
277
278
  description: zod_1.z.string(),
278
279
  currency: exports.ZCurrency,
279
280
  marketCap: zod_1.z.number(),
@@ -320,8 +321,49 @@ exports.ZAssetDetails = zod_1.z.object({
320
321
  ebitda: zod_1.z.number(),
321
322
  })),
322
323
  ceo: zod_1.z.string(),
323
- }),
324
- etfBreakdown: zod_1.z.null(),
324
+ })
325
+ .optional(),
326
+ eftDetails: zod_1.z
327
+ .object({
328
+ currency: exports.ZCurrency,
329
+ nav: zod_1.z.number(),
330
+ description: zod_1.z.string(),
331
+ priceToBook: zod_1.z.number(),
332
+ priceToEarnings: zod_1.z.number(),
333
+ aum: zod_1.z.number(),
334
+ expenseRatio: zod_1.z.number(),
335
+ })
336
+ .optional(),
337
+ etfBreakdown: zod_1.z
338
+ .object({
339
+ currency: exports.ZCurrency,
340
+ updatedAt: Base_type_1.ZDate,
341
+ holdings: zod_1.z.array(zod_1.z.object({
342
+ share: zod_1.z.number(),
343
+ marketValue: zod_1.z.number(),
344
+ amountOfShares: zod_1.z.number(),
345
+ name: zod_1.z.string(),
346
+ asset: zod_1.z.object({
347
+ _id: zod_1.z.object({
348
+ identifier: zod_1.z.string(),
349
+ assetType: zod_1.z.string(),
350
+ }),
351
+ assetType: zod_1.z.string(),
352
+ name: zod_1.z.string(),
353
+ logo: zod_1.z.string(),
354
+ security: zod_1.z.object({
355
+ website: zod_1.z.string(),
356
+ type: zod_1.z.string(),
357
+ wkn: zod_1.z.string(),
358
+ isin: zod_1.z.string(),
359
+ etfDomicile: zod_1.z.string(),
360
+ etfCompany: zod_1.z.string(),
361
+ }),
362
+ }),
363
+ })),
364
+ })
365
+ .nullable()
366
+ .optional(),
325
367
  analystEstimates: zod_1.z
326
368
  .object({
327
369
  strongBuy: zod_1.z.number(),
@@ -367,15 +409,18 @@ exports.ZAssetDetails = zod_1.z.object({
367
409
  maxValue: zod_1.z.number(),
368
410
  badgeColor: zod_1.z.string(), // hex color
369
411
  })),
370
- payoutInterval: zod_1.z.string(),
371
- payoutIntervalSource: zod_1.z.string(),
372
- dividendKPIs: zod_1.z.object({
412
+ payoutInterval: zod_1.z.string().nullable(),
413
+ payoutIntervalSource: zod_1.z.string().nullable(),
414
+ dividendKPIs: zod_1.z
415
+ .object({
373
416
  cagr3Y: zod_1.z.number(),
374
417
  cagr5Y: zod_1.z.number(),
375
418
  cagr10Y: zod_1.z.number(),
376
419
  dividendYieldPercentageTTM: zod_1.z.number(),
377
420
  dividendPerShareTTM: zod_1.z.number(),
378
- }),
379
- dividendYearlyTTM: zod_1.z.record(zod_1.z.string(), zod_1.z.number()),
421
+ })
422
+ .nullable()
423
+ .optional(),
424
+ dividendYearlyTTM: zod_1.z.record(zod_1.z.string(), zod_1.z.number()).nullable(),
380
425
  }),
381
426
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@budgetbuddyde/types",
3
- "version": "1.0.19",
3
+ "version": "1.0.20",
4
4
  "main": "lib/index.js",
5
5
  "types": "lib/index.d.ts",
6
6
  "description": "Budget Buddy Typescript Types",