@finatic/client 0.9.0 → 0.9.1

package/dist/types/types/api/broker.d.ts

@@ -1,421 +0,0 @@
-/**
- * Broker-related types
- */
-export interface BrokerAccount {
-    id: string;
-    user_broker_connection_id: string;
-    broker_provided_account_id: string;
-    account_name: string;
-    account_type: string;
-    currency: string;
-    cash_balance: number;
-    buying_power: number;
-    status: string;
-    /** ISO 8601 timestamp with timezone information */
-    created_at: string;
-    /** ISO 8601 timestamp with timezone information */
-    updated_at: string;
-    /** ISO 8601 timestamp with timezone information */
-    last_synced_at: string;
-    /** ISO 8601 timestamp with timezone information - when positions were last synced */
-    positions_synced_at: string | null;
-    /** ISO 8601 timestamp with timezone information - when orders were last synced */
-    orders_synced_at: string | null;
-    /** ISO 8601 timestamp with timezone information - when balances were last synced */
-    balances_synced_at: string | null;
-    /** ISO 8601 timestamp with timezone information - when the account was created */
-    account_created_at: string | null;
-    /** ISO 8601 timestamp with timezone information - when the account was last updated */
-    account_updated_at: string | null;
-    /** ISO 8601 timestamp with timezone information - when the first trade occurred */
-    account_first_trade_at: string | null;
-}
-export interface BrokerOrder {
-    id: string;
-    user_broker_connection_id: string;
-    broker_provided_account_id: string;
-    order_id: string;
-    symbol: string;
-    order_type: string;
-    side: 'buy' | 'sell';
-    quantity: number;
-    price: number;
-    status: string;
-    /** ISO 8601 timestamp with timezone information */
-    created_at: string;
-    /** ISO 8601 timestamp with timezone information */
-    updated_at: string;
-    /** ISO 8601 timestamp with timezone information, null if not filled */
-    filled_at: string | null;
-    filled_quantity: number;
-    filled_avg_price: number;
-}
-export interface BrokerPosition {
-    id: string;
-    user_broker_connection_id: string;
-    broker_provided_account_id: string;
-    symbol: string;
-    asset_type: string;
-    quantity: number;
-    average_price: number;
-    market_value: number;
-    cost_basis: number;
-    unrealized_gain_loss: number;
-    unrealized_gain_loss_percent: number;
-    current_price: number;
-    last_price: number;
-    /** ISO 8601 timestamp with timezone information */
-    last_price_updated_at: string;
-    /** ISO 8601 timestamp with timezone information */
-    created_at: string;
-    /** ISO 8601 timestamp with timezone information */
-    updated_at: string;
-}
-export interface BrokerBalance {
-    id: string;
-    account_id: string;
-    total_cash_value: number | null;
-    net_liquidation_value: number | null;
-    initial_margin: number | null;
-    maintenance_margin: number | null;
-    available_to_withdraw: number | null;
-    total_realized_pnl: number | null;
-    balance_created_at: string | null;
-    balance_updated_at: string | null;
-    is_end_of_day_snapshot: boolean | null;
-    raw_payload: any | null;
-    /** ISO 8601 timestamp with timezone information */
-    created_at: string;
-    /** ISO 8601 timestamp with timezone information */
-    updated_at: string;
-}
-export interface BrokerDataOptions {
-    broker_name?: string;
-    account_id?: string;
-    symbol?: string;
-}
-export interface BrokerInfo {
-    id: string;
-    name: string;
-    display_name: string;
-    description: string;
-    website: string;
-    features: string[];
-    auth_type: 'oauth' | 'api_key';
-    logo_path: string;
-    is_active: boolean;
-}
-export interface BrokerOrderParams {
-    broker: 'robinhood' | 'tasty_trade' | 'ninja_trader';
-    order_id?: string;
-    orderType: 'Market' | 'Limit' | 'Stop' | 'StopLimit';
-    assetType: 'equity' | 'equity_option' | 'crypto' | 'forex' | 'future' | 'future_option';
-    action: 'Buy' | 'Sell';
-    timeInForce: 'day' | 'gtc' | 'gtd' | 'ioc' | 'fok';
-    accountNumber: string | number;
-    symbol: string;
-    orderQty: number;
-    price?: number;
-    stopPrice?: number;
-}
-export interface BrokerExtras {
-    robinhood?: {
-        extendedHours?: boolean;
-        marketHours?: 'regular_hours' | 'extended_hours';
-        trailType?: 'percentage' | 'amount';
-    };
-    ninjaTrader?: {
-        accountSpec?: string;
-        isAutomated?: boolean;
-        activationTime?: string;
-        text?: string;
-        pegDifference?: number;
-        expireTime?: string;
-    };
-    tastyTrade?: {
-        automatedSource?: boolean;
-        priceEffect?: 'Debit' | 'Credit';
-        externalIdentifier?: string;
-        partitionKey?: string;
-        preflightId?: string;
-        source?: string;
-        valueEffect?: 'Debit' | 'Credit';
-    };
-}
-export interface BrokerConnection {
-    id: string;
-    broker_id: string;
-    user_id: string;
-    company_id: string;
-    status: 'connected' | 'disconnected' | 'error';
-    connected_at: string;
-    last_synced_at: string | null;
-    permissions: {
-        read: boolean;
-        write: boolean;
-    };
-    metadata: {
-        nickname?: string;
-        [key: string]: any;
-    };
-    needs_reauth: boolean;
-}
-export interface BrokerDataOrder {
-    id: string;
-    broker_id: string;
-    connection_id: string;
-    account_id: string;
-    order_id: string;
-    symbol: string;
-    order_type: string;
-    side: 'buy' | 'sell';
-    quantity: number;
-    price: number;
-    status: 'filled' | 'pending' | 'cancelled' | 'rejected' | 'partially_filled';
-    asset_type: 'stock' | 'option' | 'crypto' | 'future';
-    created_at: string;
-    updated_at: string;
-    filled_at?: string;
-    filled_quantity: number;
-    filled_avg_price: number;
-    metadata?: Record<string, any>;
-}
-export interface BrokerDataPosition {
-    id: string;
-    broker_id: string;
-    connection_id: string;
-    account_id: string;
-    symbol: string;
-    asset_type: 'stock' | 'option' | 'crypto' | 'future';
-    side: 'long' | 'short';
-    quantity: number;
-    average_price: number;
-    market_value: number;
-    cost_basis: number;
-    unrealized_gain_loss: number;
-    unrealized_gain_loss_percent: number;
-    current_price: number;
-    last_price: number;
-    last_price_updated_at: string;
-    position_status: 'open' | 'closed';
-    created_at: string;
-    updated_at: string;
-    metadata?: Record<string, any>;
-}
-export interface BrokerDataAccount {
-    id: string;
-    broker_id: string;
-    connection_id: string;
-    account_id: string;
-    account_name: string;
-    account_type: 'margin' | 'cash' | 'crypto_wallet' | 'live' | 'sim';
-    status: 'active' | 'inactive';
-    currency: string;
-    cash_balance: number;
-    buying_power: number;
-    equity: number;
-    created_at: string;
-    updated_at: string;
-    last_synced_at: string;
-    metadata?: Record<string, any>;
-}
-export interface OrdersFilter {
-    broker_id?: string;
-    connection_id?: string;
-    account_id?: string;
-    symbol?: string;
-    status?: 'filled' | 'pending' | 'cancelled' | 'rejected' | 'partially_filled';
-    side?: 'buy' | 'sell';
-    asset_type?: 'stock' | 'option' | 'crypto' | 'future';
-    limit?: number;
-    offset?: number;
-    created_after?: string;
-    created_before?: string;
-    with_metadata?: boolean;
-}
-export interface PositionsFilter {
-    broker_id?: string;
-    connection_id?: string;
-    account_id?: string;
-    symbol?: string;
-    side?: 'long' | 'short';
-    asset_type?: 'stock' | 'option' | 'crypto' | 'future';
-    position_status?: 'open' | 'closed';
-    limit?: number;
-    offset?: number;
-    updated_after?: string;
-    updated_before?: string;
-    with_metadata?: boolean;
-}
-export interface AccountsFilter {
-    broker_id?: string;
-    connection_id?: string;
-    account_type?: 'margin' | 'cash' | 'crypto_wallet' | 'live' | 'sim';
-    status?: 'active' | 'inactive';
-    currency?: string;
-    limit?: number;
-    offset?: number;
-    with_metadata?: boolean;
-}
-export interface BalancesFilter {
-    broker_id?: string;
-    connection_id?: string;
-    account_id?: string;
-    is_end_of_day_snapshot?: boolean;
-    limit?: number;
-    offset?: number;
-    balance_created_after?: string;
-    balance_created_before?: string;
-    with_metadata?: boolean;
-}
-export interface FilteredOrdersResponse {
-    orders: BrokerDataOrder[];
-    total: number;
-    limit: number;
-    offset: number;
-}
-export interface FilteredPositionsResponse {
-    positions: BrokerDataPosition[];
-    total: number;
-    limit: number;
-    offset: number;
-}
-export interface FilteredAccountsResponse {
-    accounts: BrokerDataAccount[];
-    total: number;
-    limit: number;
-    offset: number;
-}
-export interface FilteredBalancesResponse {
-    balances: BrokerBalance[];
-    total: number;
-    limit: number;
-    offset: number;
-}
-export interface DisconnectCompanyResponse {
-    success: boolean;
-    response_data: {
-        connection_id: string;
-        action: 'company_access_removed' | 'connection_deleted';
-        remaining_companies?: number;
-        message: string;
-    };
-    message: string;
-    status_code: number;
-}
-export interface OrderFill {
-    id: string;
-    order_id: string;
-    leg_id: string | null;
-    price: number;
-    quantity: number;
-    executed_at: string;
-    execution_id: string | null;
-    trade_id: string | null;
-    venue: string | null;
-    commission_fee: number | null;
-    created_at: string;
-    updated_at: string;
-}
-export interface OrderEvent {
-    id: string;
-    order_id: string;
-    order_group_id: string | null;
-    event_type: string | null;
-    event_time: string;
-    event_id: string | null;
-    order_status: string | null;
-    inferred: boolean;
-    confidence: number | null;
-    reason_code: string | null;
-    recorded_at: string | null;
-}
-export interface OrderLeg {
-    id: string;
-    order_id: string;
-    leg_index: number;
-    asset_type: string;
-    broker_provided_symbol: string | null;
-    quantity: number;
-    filled_quantity: number | null;
-    avg_fill_price: number | null;
-    created_at: string | null;
-    updated_at: string | null;
-}
-export interface OrderGroupOrder extends BrokerDataOrder {
-    legs: OrderLeg[];
-}
-export interface OrderGroup {
-    id: string;
-    user_broker_connection_id: string | null;
-    created_at: string;
-    updated_at: string;
-    orders: OrderGroupOrder[];
-}
-export interface PositionLot {
-    id: string;
-    position_id: string | null;
-    user_broker_connection_id: string;
-    broker_provided_account_id: string;
-    instrument_key: string;
-    asset_type: string | null;
-    side: 'long' | 'short' | null;
-    open_quantity: number;
-    closed_quantity: number;
-    remaining_quantity: number;
-    open_price: number;
-    close_price_avg: number | null;
-    cost_basis: number;
-    cost_basis_w_commission: number;
-    realized_pl: number;
-    realized_pl_w_commission: number;
-    lot_opened_at: string;
-    lot_closed_at: string | null;
-    position_group_id: string | null;
-    created_at: string;
-    updated_at: string;
-    position_lot_fills?: PositionLotFill[];
-}
-export interface PositionLotFill {
-    id: string;
-    lot_id: string;
-    order_fill_id: string;
-    fill_price: number;
-    fill_quantity: number;
-    executed_at: string;
-    commission_share: number | null;
-    created_at: string;
-    updated_at: string;
-}
-export interface OrderFillsFilter {
-    connection_id?: string;
-    limit?: number;
-    offset?: number;
-}
-export interface OrderEventsFilter {
-    connection_id?: string;
-    limit?: number;
-    offset?: number;
-}
-export interface OrderGroupsFilter {
-    broker_id?: string;
-    connection_id?: string;
-    limit?: number;
-    offset?: number;
-    created_after?: string;
-    created_before?: string;
-}
-export interface PositionLotsFilter {
-    broker_id?: string;
-    connection_id?: string;
-    account_id?: string;
-    symbol?: string;
-    position_id?: string;
-    limit?: number;
-    offset?: number;
-}
-export interface PositionLotFillsFilter {
-    connection_id?: string;
-    limit?: number;
-    offset?: number;
-}

package/dist/types/types/api/core.d.ts

@@ -1,46 +0,0 @@
-/**
- * Core API types
- */
-import { ApiPaginationInfo } from '../common/pagination';
-export interface ApiConfig {
-    baseUrl: string;
-    apiKey?: string;
-    sandbox?: boolean;
-}
-export interface ApiResponse<T> {
-    success: boolean;
-    response_data: T;
-    message: string;
-    status_code: number;
-    pagination?: ApiPaginationInfo;
-}
-export interface ApiError {
-    code: string;
-    message: string;
-    details?: Record<string, any>;
-}
-export interface RequestHeaders {
-    'Content-Type': string;
-    'X-API-Key'?: string;
-    Authorization?: string;
-    'X-CSRF-Token'?: string;
-    token?: string;
-    'User-Agent'?: string;
-    'X-Device-Info'?: string;
-    'X-Request-ID'?: string;
-    'X-Request-Timestamp'?: string;
-    'X-Request-Signature'?: string;
-    [key: string]: string | undefined;
-}
-export interface PortalResponse {
-    portalUrl: string;
-    token: string;
-    expiresIn: number;
-}
-export interface PortalUrlResponse {
-    success: boolean;
-    message: string;
-    data: {
-        portal_url: string;
-    };
-}

package/dist/types/types/api/errors.d.ts

@@ -1,31 +0,0 @@
-/**
- * Error response types matching API documentation
- */
-export interface TradeAccessDeniedError {
-    success: false;
-    response_data: null;
-    message: string;
-    status_code: 403;
-    category: 'TRADE_ACCESS_DENIED';
-}
-export interface OrderNotFoundError {
-    success: false;
-    response_data: null;
-    message: string;
-    status_code: 404;
-    category: 'ORDER_NOT_FOUND';
-}
-export interface ValidationError {
-    success: false;
-    response_data: null;
-    message: string;
-    status_code: 400;
-}
-export interface TradingNotEnabledError {
-    success: false;
-    response_data: null;
-    message: string;
-    status_code: 403;
-    code: 'TRADING_NOT_ENABLED';
-    requires_action: null;
-}

package/dist/types/types/api/orders.d.ts

@@ -1,39 +0,0 @@
-/**
- * Order-related types
- */
-export interface Order {
-    symbol: string;
-    side: 'buy' | 'sell';
-    quantity: number;
-    type_: 'market' | 'limit' | 'stop' | 'stop_limit';
-    price?: number;
-    stopPrice?: number;
-    timeInForce: 'day' | 'gtc' | 'opg' | 'cls' | 'ioc' | 'fok';
-}
-export interface OptionsOrder extends Order {
-    optionType: 'call' | 'put';
-    strikePrice: number;
-    expirationDate: string;
-}
-export interface CryptoOrderOptions {
-    quantity?: number;
-    notional?: number;
-}
-export interface OptionsOrderOptions {
-    strikePrice: number;
-    expirationDate: string;
-    optionType: 'call' | 'put';
-    contractSize?: number;
-}
-export interface OrderResponse {
-    success: boolean;
-    response_data: any;
-    message: string;
-    status_code: number;
-    category?: string;
-}
-export interface TradingContext {
-    broker?: string;
-    accountNumber?: string;
-    accountId?: string;
-}

package/dist/types/types/api/portfolio.d.ts

@@ -1,55 +0,0 @@
-/**
- * Portfolio-related types
- */
-export interface PortfolioSnapshot {
-    timestamp: string;
-    totalValue: number;
-    cash: number;
-    equity: number;
-    positions: {
-        symbol: string;
-        quantity: number;
-        averagePrice: number;
-        currentPrice: number;
-        marketValue: number;
-        unrealizedPnL: number;
-    }[];
-}
-export interface PerformanceMetrics {
-    totalReturn: number;
-    dailyReturn: number;
-    weeklyReturn: number;
-    monthlyReturn: number;
-    yearlyReturn: number;
-    maxDrawdown: number;
-    sharpeRatio: number;
-    beta: number;
-    alpha: number;
-}
-export interface Holding {
-    symbol: string;
-    quantity: number;
-    averagePrice: number;
-    currentPrice: number;
-    marketValue: number;
-    unrealizedPnL: number;
-    realizedPnL: number;
-    costBasis: number;
-    currency: string;
-}
-export interface Portfolio {
-    id: string;
-    name: string;
-    type: string;
-    status: string;
-    cash: number;
-    buyingPower: number;
-    equity: number;
-    longMarketValue: number;
-    shortMarketValue: number;
-    initialMargin: number;
-    maintenanceMargin: number;
-    lastEquity: number;
-    positions: Holding[];
-    performance: PerformanceMetrics;
-}

package/dist/types/types/common/pagination.d.ts

@@ -1,33 +0,0 @@
-/**
- * Pagination-related types and classes
- */
-export interface ApiPaginationInfo {
-    has_more: boolean;
-    next_offset: number;
-    current_offset: number;
-    limit: number;
-}
-export interface PaginationMetadata {
-    hasMore: boolean;
-    nextOffset: number;
-    currentOffset: number;
-    limit: number;
-    currentPage: number;
-    hasNext: boolean;
-    hasPrevious: boolean;
-}
-export declare class PaginatedResult<T> {
-    readonly data: T;
-    readonly metadata: PaginationMetadata;
-    private navigationCallback?;
-    constructor(data: T, paginationInfo: ApiPaginationInfo, navigationCallback?: (offset: number, limit: number) => Promise<PaginatedResult<T>>);
-    get hasNext(): boolean;
-    get hasPrevious(): boolean;
-    get currentPage(): number;
-    nextPage(): Promise<PaginatedResult<T> | null>;
-    previousPage(): Promise<PaginatedResult<T> | null>;
-    goToPage(pageNumber: number): Promise<PaginatedResult<T> | null>;
-    firstPage(): Promise<PaginatedResult<T> | null>;
-    lastPage(): Promise<PaginatedResult<T> | null>;
-    getPaginationInfo(): string;
-}

package/dist/types/types/connect.d.ts

@@ -1,58 +0,0 @@
-import { Theme } from './ui/theme';
-import { UserToken } from './api/auth';
-import { PortalTheme } from './portal';
-export interface FinaticConnectOptions {
-    /** The portal token from your backend */
-    token: string;
-    /** Optional base URL for API requests */
-    baseUrl?: string;
-    /** Optional origin for the portal */
-    origin?: string;
-    /** Callback when user successfully connects */
-    onSuccess?: (tokens: UserToken) => void;
-    /** Callback when an error occurs */
-    onError?: (error: Error) => void;
-    /** Callback when the portal is closed */
-    onClose?: () => void;
-    /** Optional theme configuration */
-    theme?: Theme;
-    /** Callback when tokens are received */
-    onTokensReceived?: (tokens: {
-        access_token?: string;
-        refresh_token?: string;
-    }) => void;
-}
-export interface FinaticUserToken {
-    accessToken: string;
-    refreshToken: string;
-    userId: string;
-    companyId: string;
-    expiresAt: Date;
-}
-export interface PortalMessage {
-    type: 'success' | 'error' | 'close' | 'resize';
-    userId?: string;
-    error?: string;
-    height?: number;
-    access_token?: string;
-    refresh_token?: string;
-}
-export interface PortalOptions {
-    /** Callback when user successfully connects */
-    onSuccess?: (userId: string, tokens?: {
-        access_token?: string;
-        refresh_token?: string;
-    }) => void;
-    /** Callback when an error occurs */
-    onError?: (error: Error) => void;
-    /** Callback when the portal is closed */
-    onClose?: () => void;
-    /** Callback when portal events occur */
-    onEvent?: (type: string, data: any) => void;
-    /** Optional theme configuration for the portal */
-    theme?: PortalTheme;
-    /** Optional list of broker names to filter by (only these brokers will be shown) */
-    brokers?: string[];
-    /** Optional email address to prefill in the portal */
-    email?: string;
-}

package/dist/types/types/index.d.ts

@@ -1,13 +0,0 @@
-/**
- * Main types barrel export
- */
-export * from './api/core';
-export * from './api/auth';
-export * from './api/broker';
-export * from './api/orders';
-export * from './api/portfolio';
-export * from './ui/theme';
-export * from './common/pagination';
-export * from './connect';
-export type { DeviceInfo } from './api/auth';
-export type { SessionResponse } from './api/auth';