@finatic/client 0.0.131

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

@@ -0,0 +1,486 @@
+/**
+ * API-related types for Finatic Connect SDK
+ */
+export interface SessionInitResponse {
+    success: boolean;
+    message: string;
+    data: {
+        one_time_token: string;
+        expires_at: string;
+    };
+}
+export interface SessionResponseData {
+    session_id: string;
+    company_id: string;
+    status: 'pending';
+    expires_at: string;
+}
+export interface SessionStartResponse {
+    data: SessionResponseData;
+    message: 'Session started successfully';
+}
+export interface OtpRequestResponse {
+    success: boolean;
+    message: string;
+    data: boolean;
+}
+export interface OtpVerifyResponse {
+    success: boolean;
+    message: string;
+    data: {
+        access_token: string;
+        refresh_token: string;
+        user_id: string;
+        expires_in: number;
+        scope: string;
+        token_type: 'Bearer';
+    };
+}
+export interface PortalUrlResponse {
+    success: boolean;
+    message: string;
+    data: {
+        portal_url: string;
+    };
+}
+export interface UserToken {
+    accessToken: string;
+    refreshToken: string;
+    expiresIn: number;
+    user_id: string;
+    tokenType: string;
+    scope: string;
+}
+export interface ApiError {
+    code: string;
+    message: string;
+    details?: Record<string, any>;
+}
+export interface ApiConfig {
+    baseUrl: string;
+    apiKey?: string;
+    sandbox?: boolean;
+}
+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 declare enum SessionState {
+    PENDING = "PENDING",
+    AUTHENTICATING = "AUTHENTICATING",
+    ACTIVE = "ACTIVE",
+    COMPLETED = "COMPLETED",
+    EXPIRED = "EXPIRED"
+}
+export type SessionStatus = SessionState;
+export interface ApiResponse<T> {
+    data: T;
+    error?: string;
+    status: number;
+}
+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 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;
+}
+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 BrokerDataOptions {
+    broker_name?: string;
+    account_id?: string;
+    symbol?: string;
+}
+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;
+}
+export interface PortalResponse {
+    portalUrl: string;
+    token: string;
+    expiresIn: number;
+}
+export interface SessionValidationResponse {
+    valid: boolean;
+    company_id: string;
+    status: string;
+}
+export interface SessionAuthenticateResponse {
+    success: boolean;
+    message: string;
+    data: {
+        access_token: string;
+        refresh_token: string;
+    };
+}
+export interface RefreshTokenRequest {
+    refresh_token: string;
+}
+export interface RefreshTokenResponse {
+    success: boolean;
+    response_data: {
+        access_token: string;
+        refresh_token: string;
+        expires_at: string;
+        company_id: string;
+        company_name: string;
+        email_verified: boolean;
+    };
+    message: string;
+}
+export interface TokenInfo {
+    accessToken: string;
+    refreshToken: string;
+    expiresAt: string;
+    userId?: string;
+}
+export interface SessionResponse {
+    data: {
+        session_id: string;
+        state: SessionState;
+        device_info?: Record<string, string>;
+        company_id?: string;
+        status?: string;
+        expires_at?: string;
+        user_id?: string | null;
+        auto_login?: boolean;
+        access_token?: string;
+        refresh_token?: string;
+        expires_in?: number;
+        token_type?: string;
+        scope?: string;
+    };
+    message: 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 DeviceInfo {
+    ip_address: string;
+    user_agent: string;
+    fingerprint: string;
+}
+export interface BrokerOrderParams {
+    broker: 'robinhood' | 'tasty_trade' | 'ninja_trader';
+    accountNumber: string;
+    symbol: string;
+    orderQty: number;
+    action: 'Buy' | 'Sell';
+    orderType: 'Market' | 'Limit' | 'Stop' | 'TrailingStop';
+    assetType: 'Stock' | 'Option' | 'Crypto' | 'Futures';
+    timeInForce: 'day' | 'gtc' | 'gtd' | 'ioc' | 'fok';
+    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 CryptoOrderOptions {
+    quantity?: number;
+    notional?: number;
+}
+export interface OptionsOrderOptions {
+    strikePrice: number;
+    expirationDate: string;
+    optionType: 'call' | 'put';
+    contractSize?: number;
+}
+export interface OrderResponse {
+    success: boolean;
+    response_data: {
+        orderId: string;
+        status: string;
+        broker?: string;
+        accountNumber?: string;
+    };
+    message: string;
+    status_code: number;
+}
+export interface TradingContext {
+    broker?: string;
+    accountNumber?: string;
+    accountId?: string;
+}
+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 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 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 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;
+}

package/dist/types/types/config.d.ts

@@ -0,0 +1,12 @@
+import { Theme } from './theme';
+export interface SDKConfig {
+    token: string;
+    theme?: Theme;
+    sandbox?: boolean;
+}
+export declare const DEFAULT_THEME: Theme;
+export declare const DEFAULT_CONFIG: SDKConfig;
+export interface PortalConfig {
+    companyId: string;
+    theme?: Theme;
+}

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

@@ -0,0 +1,51 @@
+import { Theme } from './theme';
+import { UserToken } from './api';
+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) => 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;
+}

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

@@ -0,0 +1,47 @@
+/**
+ * Error-related types for Finatic Connect SDK
+ */
+export interface BaseError {
+    code: string;
+    message: string;
+    details?: Record<string, any>;
+}
+export interface ApiError extends BaseError {
+    status: number;
+    headers?: Record<string, string>;
+}
+export interface SessionError extends BaseError {
+    sessionId?: string;
+    status?: string;
+}
+export interface AuthenticationError extends BaseError {
+    userId?: string;
+    tokenType?: string;
+}
+export interface AuthorizationError extends BaseError {
+    resource?: string;
+    permission?: string;
+}
+export interface RateLimitError extends BaseError {
+    retryAfter?: number;
+    limit?: number;
+    remaining?: number;
+}
+export interface TokenError extends BaseError {
+    tokenType?: string;
+    expiresAt?: string;
+}
+export interface ValidationError extends BaseError {
+    field?: string;
+    value?: any;
+    constraints?: string[];
+}
+export interface NetworkError extends BaseError {
+    url?: string;
+    method?: string;
+    status?: number;
+}
+export interface SecurityError extends BaseError {
+    securityContext?: Record<string, any>;
+    validationResult?: Record<string, any>;
+}

package/dist/types/types/portal.d.ts

@@ -0,0 +1,75 @@
+export interface PortalConfig {
+    width?: string;
+    height?: string;
+    position?: 'center' | 'top' | 'bottom';
+    zIndex?: number;
+}
+export interface PortalThemeConfig {
+    mode: 'dark' | 'light' | 'auto';
+    colors: {
+        background: {
+            primary: string;
+            secondary: string;
+            tertiary: string;
+            accent: string;
+            glass: string;
+        };
+        status: {
+            connected: string;
+            disconnected: string;
+            warning: string;
+            pending: string;
+            error: string;
+            success: string;
+        };
+        text: {
+            primary: string;
+            secondary: string;
+            muted: string;
+            inverse: string;
+        };
+        border: {
+            primary: string;
+            secondary: string;
+            hover: string;
+            focus: string;
+            accent: string;
+        };
+        input: {
+            background: string;
+            border: string;
+            borderFocus: string;
+            text: string;
+            placeholder: string;
+        };
+        button: {
+            primary: {
+                background: string;
+                text: string;
+                hover: string;
+                active: string;
+            };
+            secondary: {
+                background: string;
+                text: string;
+                border: string;
+                hover: string;
+                active: string;
+            };
+        };
+    };
+    branding?: {
+        primaryColor?: string;
+    };
+}
+export type PortalThemePreset = 'dark' | 'light' | 'corporateBlue' | 'purple' | 'green' | 'orange';
+export interface PortalTheme {
+    preset?: PortalThemePreset;
+    custom?: PortalThemeConfig;
+}
+export interface PortalProps {
+    config: PortalConfig;
+    onClose?: () => void;
+    onReady?: () => void;
+    onError?: (error: Error) => void;
+}

package/dist/types/types/security.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Security-related types for Finatic Connect SDK
+ */
+export interface DeviceFingerprint {
+    userAgent: string;
+    language: string;
+    platform: string;
+    screenResolution: string;
+    timezone: string;
+}
+export interface SecurityHeaders {
+    'X-Request-ID': string;
+    'X-Request-Timestamp': string;
+    'X-Request-Signature': string;
+    'X-Device-Fingerprint': string;
+    'User-Agent': string;
+}
+export interface SecurityConfig {
+    requestTimeout: number;
+    maxRetries: number;
+    retryDelay: number;
+    validateDeviceFingerprint: boolean;
+    validateRequestSignature: boolean;
+}
+export interface SecurityContext {
+    deviceFingerprint: string | null;
+    userAgent: string | null;
+    lastRequestTimestamp: number;
+    requestCount: number;
+}
+export interface SecurityValidationResult {
+    isValid: boolean;
+    error?: string;
+    details?: Record<string, any>;
+}