@finatic/client 0.9.0 → 0.9.1

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Initial release
+
+## [0.1.0] - YYYY-MM-DD
+
+### Added
+- Initial SDK release

package/LICENSE

@@ -0,0 +1,39 @@
+PROPRIETARY LICENSE
+
+Copyright (c) 2025 Finatic. All Rights Reserved.
+
+NOTICE: This software development kit (the "SDK") and associated documentation files (the "Software") are the proprietary and confidential property of Finatic. All rights, title, and interest in and to the Software are and shall remain the exclusive property of Finatic.
+
+GRANT OF LICENSE:
+
+Subject to the terms and conditions of this License, Finatic hereby grants you a limited, non-exclusive, non-transferable, revocable license to:
+
+1. Use the SDK solely to develop, test, and operate applications that integrate with Finatic's services;
+2. Modify the SDK solely for your internal use in connection with such applications;
+3. Distribute the SDK only as embedded within your applications, provided that such distribution is necessary for the operation of your applications that use Finatic's services.
+
+RESTRICTIONS ON USE:
+
+The following restrictions apply to your use of the Software:
+
+1. NO STANDALONE DISTRIBUTION: You may not distribute, publish, share, transfer, give, or provide the SDK as a standalone product, library, or package to any third party, including but not limited to individuals, companies, organizations, or any other entities, without express written authorization from Finatic.
+
+2. NO RESALE OR REPACKAGING: You may not sell, resell, lease, rent, license, sublicense, or otherwise monetize the SDK as a standalone product. You may not repackage, rebrand, or resell the SDK under your own name or brand.
+
+3. NO COMPETING PRODUCTS: You may not use the SDK to create a competing or substitute product, service, or SDK that provides similar functionality to Finatic's services.
+
+4. NO REVERSE ENGINEERING: You may not reverse engineer, decompile, disassemble, or otherwise analyze or examine the Software to extract source code, algorithms, or other proprietary information, except to the extent such activities are expressly permitted by applicable law notwithstanding this limitation.
+
+5. CONFIDENTIALITY: All information contained in the Software is confidential and proprietary. You must maintain strict confidentiality and shall not disclose any information about the Software's internal structure, design, or implementation to any unauthorized party.
+
+6. NO PUBLIC REPOSITORY PUBLICATION: You may not publish, post, upload, or make the SDK available on any public or private platform, repository, website, or any other medium, including but not limited to GitHub, GitLab, Bitbucket, NPM, PyPI, or any package registry, except as embedded within your applications as permitted above.
+
+TERMINATION:
+
+This license is effective until terminated. Finatic may terminate this license at any time without notice. Upon termination, you must immediately cease all use of the Software and destroy all copies in your possession.
+
+VIOLATION OF THESE TERMS:
+
+Any unauthorized use, modification, distribution, publication, or disclosure of the Software or any portion thereof may result in severe civil and criminal penalties, and Finatic will enforce its intellectual property rights to the fullest extent of the law.
+
+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 FINATIC OR ITS OFFICERS, DIRECTORS, EMPLOYEES, OR AGENTS 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,465 +1,94 @@
-# Finatic Client SDK
+# Client
 
-A comprehensive browser SDK for integrating Finatic Client into your web applications.
+A comprehensive browser SDK for integrating Finatic Client into your web applications. Connect your users to multiple brokerages through a unified, standardized interface.
+
+**Finatic is a brokerage first aggregator. We simplify, standardize and enhance broker data.**
 
 ## Installation
 
 ```bash
 npm install @finatic/client
-# or
-yarn add @finatic/client
-```
-
-## Basic Usage
-
-### Simple Initialization
-
-```typescript
-import { FinaticConnect } from '@finatic/client';
-
-// Just pass the token - everything else uses defaults
-const finatic = await FinaticConnect.init('your-one-time-token');
-```
-
-### With User ID (for returning users)
-
-```typescript
-// Pass token and user ID from previous session
-const finatic = await FinaticConnect.init('your-one-time-token', 'user-123');
-```
-
-### With Custom Configuration
-
-```typescript
-// Pass token, user ID, and custom API URL
-const finatic = await FinaticConnect.init('your-one-time-token', 'user-123', {
-  baseUrl: 'https://api.finatic.dev',
-});
-```
-
-## Portal Management
-
-### Opening the Portal
-
-```typescript
-// Open the portal with basic configuration
-await finatic.openPortal({
-  onSuccess: userId => {
-    console.log('Authentication successful:', userId);
-  },
-  onError: error => {
-    console.error('Authentication failed:', error);
-  },
-  onClose: () => {
-    console.log('Portal closed');
-  },
-});
-
-// Open portal with broker filtering
-await finatic.openPortal({
-  brokers: ['alpaca', 'robinhood'], // Only show these brokers
-  onSuccess: userId => {
-    console.log('Authentication successful:', userId);
-  },
-});
-
-// Open portal with theming
-await finatic.openPortal({
-  theme: {
-    primaryColor: '#007bff',
-    logoUrl: 'https://example.com/logo.png',
-  },
-});
-```
-
-### Closing the Portal
-
-```typescript
-// Close the portal
-await finatic.closePortal();
-```
-
-## Data Access
-
-### Paginated Data Access
-
-The SDK provides a consistent pagination pattern using `get*()` methods with navigation:
-
-```typescript
-// Get orders with pagination
-const ordersPage = await finatic.getOrders({
-  page: 1,
-  perPage: 50,
-  filter: { status: 'filled', symbol: 'AAPL' },
-});
-
-// Navigate through pages
-const nextPage = await ordersPage.nextPage();
-const prevPage = await ordersPage.previousPage();
-
-// Check pagination status
-console.log('Has next page:', ordersPage.hasNext);
-console.log('Has previous page:', ordersPage.hasPrevious);
-console.log('Current page:', ordersPage.page);
-console.log('Total pages:', ordersPage.totalPages);
-```
-
-### Get All Data (Convenience Methods)
-
-```typescript
-// Get all data across all pages
-const allOrders = await finatic.getAllOrders();
-const allPositions = await finatic.getAllPositions();
-const allAccounts = await finatic.getAllAccounts();
-const allBalances = await finatic.getAllBalances();
-```
-
-### Convenience Filter Methods
-
-```typescript
-// Get filtered data
-const openPositions = await finatic.getOpenPositions();
-const filledOrders = await finatic.getFilledOrders();
-const pendingOrders = await finatic.getPendingOrders();
-const activeAccounts = await finatic.getActiveAccounts();
-
-// Get data by symbol
-const aaplOrders = await finatic.getOrdersBySymbol('AAPL');
-const aaplPositions = await finatic.getPositionsBySymbol('AAPL');
-
-// Get data by broker
-const robinhoodOrders = await finatic.getOrdersByBroker('robinhood');
-const robinhoodPositions = await finatic.getPositionsByBroker('robinhood');
-```
-
-## Trading Operations
-
-### General Order Placement
-
-```typescript
-// Place a market order
-const orderResponse = await finatic.placeOrder({
-  symbol: 'AAPL',
-  side: 'buy',
-  quantity: 10,
-  orderType: 'market',
-  timeInForce: 'day',
-});
-
-// Place a limit order
-const limitOrderResponse = await finatic.placeOrder({
-  symbol: 'AAPL',
-  side: 'buy',
-  quantity: 10,
-  orderType: 'limit',
-  price: 150.0,
-  timeInForce: 'gtc',
-});
-```
-
-### Asset-Specific Order Methods
-
-#### Stock Orders
-
-```typescript
-// Stock market order
-const response = await finatic.placeStockMarketOrder('AAPL', 10, 'buy', 'robinhood', '123456789');
-
-// Stock limit order
-const response = await finatic.placeStockLimitOrder(
-  'AAPL',
-  10,
-  'buy',
-  150.0,
-  'gtc',
-  'robinhood',
-  '123456789'
-);
-
-// Stock stop order
-const response = await finatic.placeStockStopOrder(
-  'AAPL',
-  10,
-  'sell',
-  140.0,
-  'gtc',
-  'robinhood',
-  '123456789'
-);
-```
-
-#### Crypto Orders
-
-```typescript
-// Crypto market order
-const response = await finatic.placeCryptoMarketOrder(
-  'BTC-USD',
-  0.1,
-  'buy',
-  'coinbase',
-  '123456789'
-);
-
-// Crypto limit order
-const response = await finatic.placeCryptoLimitOrder(
-  'BTC-USD',
-  0.1,
-  'buy',
-  50000.0,
-  'gtc',
-  'coinbase',
-  '123456789'
-);
-```
-
-#### Options Orders
-
-```typescript
-// Options market order
-const response = await finatic.placeOptionsMarketOrder(
-  'AAPL240315C00150000',
-  1,
-  'buy',
-  'tasty_trade',
-  '123456789'
-);
-
-// Options limit order
-const response = await finatic.placeOptionsLimitOrder(
-  'AAPL240315C00150000',
-  1,
-  'buy',
-  5.0,
-  'gtc',
-  'tasty_trade',
-  '123456789'
-);
-```
-
-#### Futures Orders
-
-```typescript
-// Futures market order
-const response = await finatic.placeFuturesMarketOrder('ES', 1, 'buy', 'ninja_trader', '123456789');
-
-// Futures limit order
-const response = await finatic.placeFuturesLimitOrder(
-  'ES',
-  1,
-  'buy',
-  4500.0,
-  'gtc',
-  'ninja_trader',
-  '123456789'
-);
 ```
 
-### Order Management
+## Quick Start
 
 ```typescript
-// Cancel an order
-const response = await finatic.cancelOrder('order-123', 'robinhood', 'connection-456');
-
-// Modify an order
-const response = await finatic.modifyOrder(
-  'order-123',
-  { price: 155.0, quantity: 5 },
-  'robinhood',
-  'connection-456'
-);
-```
-
-## Broker Information
-
-```typescript
-// Get list of supported brokers
-const brokers = await finatic.getBrokerList();
+import { FinaticClient from '@finatic/client';
 
-// Get broker connections
-const connections = await finatic.getBrokerConnections();
-
-// Disconnect a company from a broker connection
-const disconnectResponse = await finatic.disconnectCompany('connection-uuid-here');
-console.log('Disconnect action:', disconnectResponse.response_data.action);
+// TODO: Add example usage
 ```
 
-## Authentication
+## Documentation
 
-```typescript
-// Check authentication status
-const isAuthenticated = finatic.isAuthed();
-const isAuthenticatedAlt = finatic.is_authenticated();
+Full documentation is available at [docs.finatic.com](/client/typescript).
 
-// Get user ID
-const userId = finatic.getUserId();
+## Development
 
-// Set user ID (for returning users)
-finatic.setUserId('user-123');
-```
-
-## Error Handling
-
-```typescript
-import { AuthenticationError, ApiError, ValidationError } from '@finatic/client';
-
-try {
-  const orders = await finatic.getOrders();
-} catch (error) {
-  if (error instanceof AuthenticationError) {
-    console.error('Authentication failed:', error.message);
-  } else if (error instanceof ValidationError) {
-    console.error('Invalid request:', error.message);
-  } else if (error instanceof ApiError) {
-    console.error('API error:', error.message);
-  }
-}
-```
-
-## Advanced Usage
-
-### Custom Filters
-
-```typescript
-// Get orders with custom filters
-const orders = await finatic.getOrders({
-  page: 1,
-  perPage: 50,
-  filter: {
-    status: 'filled',
-    symbol: 'AAPL',
-    broker: 'robinhood',
-  },
-});
-```
+```bash
+# Install dependencies
+npm install
 
-### Pagination Navigation
+# Build
+npm run build
 
-```typescript
-// Get paginated results with navigation
-const ordersPage = await finatic.getOrders({ page: 1, perPage: 100 });
+# Run tests
+npm test
 
-// Navigate through pages
-if (ordersPage.hasNext) {
-  const nextPage = await ordersPage.nextPage();
-}
+# Lint
+npm run lint
 
-if (ordersPage.hasPrevious) {
-  const prevPage = await ordersPage.previousPage();
-}
+# Format
+npm run format
 ```
 
-### Session Management
+## Quality Checks
 
-```typescript
-// The SDK automatically manages sessions
-// Sessions are kept alive for 24 hours by default
-// No manual session management required
-```
+Run all quality checks to ensure code quality:
 
-## Order and Position Detail Data
-
-### Getting Order Fills
-
-Order fills represent individual execution fills for an order:
-
-```typescript
-// Get fills for a specific order
-const fills = await finatic.getOrderFills('order-123', {
-  connection_id: 'connection-456',
-  limit: 50,
-  offset: 0,
-});
-```
-
-### Getting Order Events
-
-Order events represent lifecycle events for an order:
+```bash
+# Run all quality checks (format, lint, type check, build)
+npm run quality:check
 
-```typescript
-// Get events for a specific order
-const events = await finatic.getOrderEvents('order-123', {
-  connection_id: 'connection-456',
-  limit: 100,
-});
+# Fix all auto-fixable issues (format, lint) and build
+npm run quality:fix
 ```
 
-### Getting Order Groups
-
-Order groups contain multiple related orders:
-
-```typescript
-// Get order groups with filters
-const groups = await finatic.getOrderGroups({
-  broker_id: 'robinhood',
-  connection_id: 'connection-456',
-  created_after: '2024-01-01T00:00:00Z',
-  limit: 50,
-});
-```
+Individual quality checks:
 
-### Getting Position Lots (Tax Lots)
+```bash
+# Format check (without modifying files)
+npm run format:check
+# Format fix (modifies files)
+npm run format:fix
 
-Position lots are used for tax reporting and track when positions were opened/closed:
+# Lint check
+npm run lint
+# Lint fix (modifies files)
+npm run lint:fix
 
-```typescript
-// Get position lots for tax reporting
-const lots = await finatic.getPositionLots({
-  broker_id: 'robinhood',
-  account_id: '123456789',
-  symbol: 'AAPL',
-  limit: 100,
-});
-```
+# Type check
+npm run type:check
 
-### Getting Position Lot Fills
+# Syntax check (strict linting)
+npm run syntax:check
+# Syntax fix (modifies files)
+npm run syntax:fix
 
-Position lot fills show the execution details for each lot:
+# Import check
+npm run import:check
 
-```typescript
-// Get fills for a specific position lot
-const lotFills = await finatic.getPositionLotFills('lot-123', {
-  connection_id: 'connection-456',
-  limit: 50,
-});
+# Build check
+npm run build
 ```
 
-## Type Definitions
-
-The SDK includes comprehensive TypeScript definitions for all data structures:
-
-- `BrokerDataOrder`: Order information
-- `BrokerDataPosition`: Position information
-- `BrokerDataAccount`: Account information
-- `BrokerBalance`: Balance information
-- `BrokerInfo`: Broker information
-- `BrokerConnection`: Connection information
-- `OrderResponse`: Order operation responses
-- `PaginatedResult`: Paginated data responses
-- `OrderFill`: Order fill information
-- `OrderEvent`: Order event information
-- `OrderGroup`: Order group information
-- `PositionLot`: Position lot (tax lot) information
-- `PositionLotFill`: Position lot fill information
-
-## Error Types
-
-- `AuthenticationError`: Authentication failures
-- `ApiError`: API request failures
-- `ValidationError`: Invalid request parameters
-- `ConnectionError`: Network connectivity issues
-
-## Browser Support
+## License
 
-- Chrome 80+
-- Firefox 75+
-- Safari 13+
-- Edge 80+
+MIT License
 
-## Requirements
+## Copyright
 
-- Modern browser with ES2018+ support
-- No external dependencies
+© Copyright 2025 Finatic. All Rights Reserved.
 
-## License
+---
 
-MIT License
+**Finatic** - Fast. Secure. Standardized.