fmp-node-types 0.1.4 → 0.2.0-beta.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 FMP Node Wrapper
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 FMP Node Wrapper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,86 +1,89 @@
-# fmp-node-types
-
-**Internal package** - Shared TypeScript types for the FMP Node Wrapper ecosystem.
-
-## Overview
-
-This is an **internal package** used within the FMP Node Wrapper monorepo. It contains all TypeScript type definitions used across the FMP Node Wrapper packages.
-
-## ⚠️ Important Note
-
-**This package is NOT published to npm and should NOT be installed directly by users.**
-
-All types are available through the main `fmp-node-api` package:
-
-```bash
-npm install fmp-node-api
-# or
-yarn add fmp-node-api
-# or
-pnpm add fmp-node-api
-```
-
-## Usage (for end users)
-
-```typescript
-import type { Quote, CompanyProfile, FinancialStatement } from 'fmp-node-api';
-
-// Use types in your code
-const quote: Quote = {
-  symbol: 'AAPL',
-  name: 'Apple Inc.',
-  price: 150.0,
-  // ... other properties
-};
-```
-
-## Available Types
-
-### Common Types
-
-- `APIResponse<T>` - Base API response wrapper
-- `FMPConfig` - Configuration interface
-- `SymbolParams` - Symbol-based parameters
-- `DateRangeParams` - Date range parameters
-- `PaginationParams` - Pagination parameters
-- `PeriodParams` - Period parameters (annual/quarter)
-
-### Quote Types
-
-- `Quote` - Unified quote data structure
-- `HistoricalPriceData` - Historical price data
-- `HistoricalPriceResponse` - Historical price response
-
-### Financial Types
-
-- `IncomeStatement` - Income statement data
-- `BalanceSheet` - Balance sheet data
-- `CashFlowStatement` - Cash flow statement data
-- `FinancialRatio` - Financial ratios
-- `Earnings` - Earnings data
-
-### Company Types
-
-- `CompanyProfile` - Company information
-- `Executive` - Executive data
-- `Employee` - Employee information
-
-### Market Types
-
-- `MarketIndex` - Market index data
-- `SectorPerformance` - Sector performance data
-
-### And many more...
-
-## Development
-
-This package is part of the FMP Node Wrapper monorepo. To contribute:
-
-1. Clone the repository
-2. Install dependencies: `pnpm install`
-3. Build the package: `pnpm build`
-4. Run tests: `pnpm test`
-
-## License
-
-MIT
+# fmp-node-types
+
+**Internal package** - Shared TypeScript types for the FMP Node Wrapper ecosystem.
+
+## Overview
+
+This is an **internal package** used within the FMP Node Wrapper monorepo. It contains all TypeScript type definitions used across the FMP Node Wrapper packages.
+
+## ⚠️ Important Note
+
+**This package is NOT published to npm and should NOT be installed directly by users.**
+
+All types are available through the main `fmp-node-api` package:
+
+```bash
+npm install fmp-node-api
+# or
+yarn add fmp-node-api
+# or
+pnpm add fmp-node-api
+```
+
+## Usage (for end users)
+
+```typescript
+import type { Quote, CompanyProfile, IncomeStatement } from 'fmp-node-api';
+
+// Use types in your code
+const quote: Quote = {
+  symbol: 'AAPL',
+  name: 'Apple Inc.',
+  price: 150.0,
+  // ... other properties
+};
+```
+
+## Available Types
+
+### Common Types
+
+- `APIResponse<T>` - Base API response wrapper
+- `FMPConfig` - Configuration interface
+- `SymbolParams` - Symbol-based parameters
+- `DateRangeParams` - Date range parameters
+- `PaginationParams` - Pagination parameters
+- `PeriodParams` - Period parameters (annual/quarter)
+
+### Quote Types
+
+- `Quote` - Unified quote data structure
+- `HistoricalPriceData` - Historical price data
+- `HistoricalPriceResponse` - Historical price response
+
+### Financial Types
+
+- `IncomeStatement` - Income statement data
+- `BalanceSheet` - Balance sheet data
+- `CashFlowStatement` - Cash flow statement data
+- `FinancialRatios` - Financial ratios
+- `KeyMetrics` - Key financial metrics
+
+### Company Types
+
+- `CompanyProfile` - Company information
+- `ExecutiveCompensation` - Executive compensation data
+- `SharesFloat` - Shares float and outstanding data
+- `HistoricalEmployeeCount` - Historical employee counts
+
+### Market Types
+
+- `MarketIndex` - Market index data
+- `MarketPerformance` - Market performance data
+- `MarketSectorPerformance` - Sector performance data
+- `MarketHours` - Market trading hours
+
+### And many more...
+
+## Development
+
+This package is part of the FMP Node Wrapper monorepo. To contribute:
+
+1. Clone the repository
+2. Install dependencies: `pnpm install`
+3. Build the package: `pnpm build`
+4. Type-check: `pnpm type-check`
+
+## License
+
+MIT