expo-finance-kit/build/ExpoFinanceKit.types.d.ts

Native Expo module for Apple FinanceKit - Access financial data from Apple Card and other accounts

/**
 * Core type definitions for Expo Finance Kit
 * Provides comprehensive type safety for Apple FinanceKit integration
 */
/**
 * Event types supported by the ExpoFinanceKit module
 */
export type ExpoFinanceKitModuleEvents = {
    onAuthorizationStatusChanged: (params: AuthorizationStatusChangedPayload) => void;
    onTransactionsChanged: (params: TransactionsChangedPayload) => void;
};
/**
 * Payload for authorization status change events
 */
export type AuthorizationStatusChangedPayload = {
    status: AuthorizationStatus;
    timestamp: number;
};
/**
 * Payload for transaction change events
 */
export type TransactionsChangedPayload = {
    accountId: string;
    timestamp: number;
    inserted?: Transaction[];
    updated?: Transaction[];
    deleted?: string[];
    hasHistoryToken?: boolean;
};
/**
 * Possible authorization statuses for FinanceKit access
 */
export type AuthorizationStatus = 'notDetermined' | 'denied' | 'authorized' | 'unavailable';
/**
 * Authorization request result
 */
export interface AuthorizationResult {
    granted: boolean;
    status: AuthorizationStatus;
}
/**
 * Account types supported by FinanceKit
 */
export declare enum AccountType {
    Asset = "asset",
    Liability = "liability"
}
/**
 * Financial account information
 */
export interface Account {
    id: string;
    institutionName: string;
    displayName: string;
    accountDescription?: string;
    currencyCode: string;
    accountType: AccountType;
    createdAt?: number;
    lastUpdated?: number;
    balance: number;
}
/**
 * Extended account information with additional metadata
 */
export interface AccountWithMetadata extends Account {
    isActive: boolean;
    lastTransactionDate?: number;
    accountNumber?: string;
}
/**
 * Credit/Debit indicator for transactions
 */
export declare enum CreditDebitIndicator {
    Credit = "credit",
    Debit = "debit"
}
/**
 * Transaction status types
 */
export declare enum TransactionStatus {
    Authorized = "authorized",
    Booked = "booked",
    Pending = "pending",
    Rejected = "rejected"
}
/**
 * Comprehensive transaction types matching Apple FinanceKit
 */
export declare enum TransactionType {
    Adjustment = "adjustment",
    ATM = "atm",
    BillPayment = "billPayment",
    Check = "check",
    Deposit = "deposit",
    DirectDebit = "directDebit",
    DirectDeposit = "directDeposit",
    Dividend = "dividend",
    Fee = "fee",
    Interest = "interest",
    Loan = "loan",
    PointOfSale = "pointOfSale",
    Refund = "refund",
    StandingOrder = "standingOrder",
    Transfer = "transfer",
    Unknown = "unknown",
    Withdrawal = "withdrawal"
}
/**
 * Merchant Category Code (MCC) for transaction classification
 */
export type MerchantCategoryCode = number;
/**
 * Core transaction data
 */
export interface Transaction {
    id: string;
    accountId: string;
    amount: number;
    currencyCode: string;
    transactionDate: number;
    merchantName?: string;
    transactionDescription: string;
    merchantCategoryCode?: MerchantCategoryCode;
    status: TransactionStatus;
    transactionType: TransactionType;
    creditDebitIndicator: CreditDebitIndicator;
}
/**
 * Extended transaction with additional details
 */
export interface TransactionWithDetails extends Transaction {
    category?: TransactionCategory;
    location?: TransactionLocation;
    tags?: string[];
    notes?: string;
    attachments?: TransactionAttachment[];
}
/**
 * Transaction category for better organization
 */
export interface TransactionCategory {
    id: string;
    name: string;
    icon?: string;
    color?: string;
}
/**
 * Location information for a transaction
 */
export interface TransactionLocation {
    latitude?: number;
    longitude?: number;
    address?: string;
    city?: string;
    state?: string;
    country?: string;
    postalCode?: string;
}
/**
 * Transaction attachment (receipt, invoice, etc.)
 */
export interface TransactionAttachment {
    id: string;
    type: 'image' | 'pdf' | 'other';
    url: string;
    thumbnailUrl?: string;
    fileName?: string;
    fileSize?: number;
}
/**
 * Balance types available in FinanceKit
 */
export declare enum BalanceType {
    Available = "available",
    Booked = "booked",
    AvailableAndBooked = "availableAndBooked"
}
/**
 * Account balance information
 */
export interface AccountBalance {
    id: string;
    accountId: string;
    amount: number;
    currencyCode: string;
    balanceType?: BalanceType;
    asOfDate?: number;
}
/**
 * Detailed balance information with breakdowns
 */
export interface DetailedBalance extends AccountBalance {
    availableBalance?: number;
    bookedBalance?: number;
    pendingCredits?: number;
    pendingDebits?: number;
    creditLimit?: number;
    minimumPaymentDue?: number;
    paymentDueDate?: number;
}
/**
 * Options for querying transactions
 */
export interface TransactionQueryOptions {
    accountId?: string;
    startDate?: Date | number;
    endDate?: Date | number;
    minAmount?: number;
    maxAmount?: number;
    merchantName?: string;
    transactionTypes?: TransactionType[];
    statuses?: TransactionStatus[];
    creditDebitIndicator?: CreditDebitIndicator;
    merchantCategoryCodes?: MerchantCategoryCode[];
    limit?: number;
    offset?: number;
    sortBy?: 'date' | 'amount' | 'merchantName';
    sortOrder?: 'asc' | 'desc';
}
/**
 * Options for querying accounts
 */
export interface AccountQueryOptions {
    accountTypes?: AccountType[];
    institutionNames?: string[];
    currencyCodes?: string[];
    isActive?: boolean;
}
/**
 * Options for querying balances
 */
export interface BalanceQueryOptions {
    accountIds?: string[];
    balanceTypes?: BalanceType[];
    asOfDate?: Date | number;
}
/**
 * Spending insights for a given period
 */
export interface SpendingInsights {
    periodStart: number;
    periodEnd: number;
    totalSpent: number;
    totalIncome: number;
    netCashFlow: number;
    categoriesBreakdown: CategoryBreakdown[];
    merchantsBreakdown: MerchantBreakdown[];
    dailyBalances?: DailyBalance[];
}
/**
 * Spending breakdown by category
 */
export interface CategoryBreakdown {
    category: string;
    amount: number;
    percentage: number;
    transactionCount: number;
    averageTransaction: number;
}
/**
 * Spending breakdown by merchant
 */
export interface MerchantBreakdown {
    merchantName: string;
    amount: number;
    percentage: number;
    transactionCount: number;
    lastTransactionDate: number;
}
/**
 * Daily balance snapshot
 */
export interface DailyBalance {
    date: number;
    balance: number;
    credits: number;
    debits: number;
}
/**
 * Custom error codes for FinanceKit operations
 */
export declare enum FinanceKitErrorCode {
    Unavailable = "FINANCEKIT_UNAVAILABLE",
    Unauthorized = "FINANCEKIT_UNAUTHORIZED",
    InvalidAccountId = "INVALID_ACCOUNT_ID",
    AccountNotFound = "ACCOUNT_NOT_FOUND",
    InvalidDateRange = "INVALID_DATE_RANGE",
    RateLimitExceeded = "RATE_LIMIT_EXCEEDED",
    NetworkError = "NETWORK_ERROR",
    Unknown = "UNKNOWN_ERROR"
}
/**
 * FinanceKit error with additional context
 */
export interface FinanceKitError extends Error {
    code: FinanceKitErrorCode;
    details?: Record<string, any>;
}
/**
 * Main interface for the ExpoFinanceKit module
 */
export interface ExpoFinanceKitModule {
    isAvailable: boolean;
    requestAuthorization(): Promise<boolean>;
    getAuthorizationStatus(): Promise<AuthorizationStatus>;
    getAccounts(options?: AccountQueryOptions): Promise<Account[]>;
    getTransactions(accountId?: string, startDate?: number, endDate?: number): Promise<Transaction[]>;
    getBalances(options?: BalanceQueryOptions): Promise<AccountBalance[]>;
    getBalanceForAccount(accountId: string): Promise<AccountBalance>;
    startMonitoringTransactions(accountIds?: string[]): Promise<void>;
    stopMonitoringTransactions(): Promise<void>;
    getHistoryToken(accountId: string): Promise<string | null>;
    clearHistoryToken(accountId: string): Promise<void>;
    setAppGroupIdentifier(identifier: string): Promise<void>;
    processPendingChanges(): Promise<void>;
    addListener(eventName: keyof ExpoFinanceKitModuleEvents, listener: Function): void;
    removeListener(eventName: keyof ExpoFinanceKitModuleEvents, listener: Function): void;
    removeAllListeners(eventName?: keyof ExpoFinanceKitModuleEvents): void;
}
/**
 * Represents a monetary amount with currency
 */
export interface Money {
    amount: number;
    currencyCode: string;
}
/**
 * Represents a date range for queries
 */
export interface DateRange {
    startDate: Date | number;
    endDate: Date | number;
}
/**
 * Pagination options
 */
export interface PaginationOptions {
    limit?: number;
    offset?: number;
}
/**
 * Sort options
 */
export interface SortOptions<T> {
    sortBy?: T;
    sortOrder?: 'asc' | 'desc';
}
//# sourceMappingURL=ExpoFinanceKit.types.d.ts.map