server/controllers/ofx.ts

Rama main · réplica de lectura del repositorio original.

import { parse as parseOfx } from 'ofx-js';

import { assert, KError, makeLogger } from '../helpers';
import type { Account, Transaction } from '../models';
import { SOURCE_NAME as MANUAL_BANK_NAME } from '../providers/manual';

const log = makeLogger('controllers/ofx');

const accountsTypesMap = {
    CHECKING: 'account-type.checking',
    SAVINGS: 'account-type.savings',
    CREDITLINE: 'account-type.loan', // line of credit
    MONEYMRKT: 'account-type.unknown', // money market
    CD: 'account-type.unknown', // certificate of deposit
};

const transactionsTypesMap = {
    CREDIT: 'type.card',
    DEBIT: 'type.card',
    INT: 'type.bankfee', // Interest earned or paid (depends on signage of amount)
    DIV: 'type.bankfee', // Dividend
    FEE: 'type.bankfee',
    SRVCHG: 'type.bankfee',
    DEP: 'type.cash_deposit',
    ATM: 'type.withdrawal', // ATM debit or credit (depends on signage of amount)
    POS: 'type.card', // Point of sale debit or credit (depends on signage of amount)
    XFER: 'type.transfer',
    CHECK: 'type.check',
    PAYMENT: 'type.card',
    CASH: 'type.withdrawal', // Actually an electronic payment
    DIRECTDEP: 'type.withdrawal',
    DIRECTDEBIT: 'type.cash_deposit',
    REPEATPMT: 'type.card', // Repeating payment/standing order
    OTHER: 'type.unknown',
    HOLD: 'type.unknown',
};

// Parse an OFX DateTimeType value and returns a Date. This relies on Date.parse to check invalid
// date values.
export function parseOfxDate(date: any): Date | null {
    if (typeof date !== 'string') {
        return null;
    }

    // See OFX_Common.xsd in https://www.ofx.net/downloads/OFX%202.2.0%20schema.zip
    const parsedDate =
        /(\d{4})(\d{2})(\d{2})(?:(\d{2})(\d{2})(\d{2}))?(?:\.(\d{3}))?(?:\[([-+]?\d{1,2}):\w{3}\])?/.exec(
            date
        );

    if (!parsedDate) {
        return null;
    }

    // The first line refers to the whole string
    const [
        ,
        year,
        month,
        day,
        hours = '00',
        minutes = '00',
        seconds = '00',
        milliseconds = '000',
        timezoneOffset = 'Z',
    ] = parsedDate;

    let normalizedTimezoneOffset = timezoneOffset;

    if (timezoneOffset !== 'Z') {
        const parsedTimezoneOffset = parseInt(timezoneOffset, 10);
        if (parsedTimezoneOffset < -12 || parsedTimezoneOffset > 14) {
            return null;
        }

        const timezoneOffsetFirstChar = timezoneOffset[0];
        if (timezoneOffsetFirstChar === '+' || timezoneOffsetFirstChar === '-') {
            if (timezoneOffset.length === 2) {
                normalizedTimezoneOffset = `${timezoneOffsetFirstChar}0${timezoneOffset[1]}`;
            }
        } else {
            if (timezoneOffset.length === 1) {
                normalizedTimezoneOffset = `0${timezoneOffset}`;
            }

            normalizedTimezoneOffset = `+${normalizedTimezoneOffset}`;
        }

        normalizedTimezoneOffset = `${normalizedTimezoneOffset}:00`;
    }

    // Transform it to a parsable ISO string and then to a timestamp to assure its validity.
    const timestamp = Date.parse(
        `${year}-${month}-${day}T${hours}:${minutes}:${seconds}.${milliseconds}${normalizedTimezoneOffset}`
    );
    if (!isNaN(timestamp)) {
        return new Date(timestamp);
    }

    return null;
}

export async function ofxToKresus(ofx: string) {
    // See http://www.ofx.net/downloads/OFX%202.2.pdf.
    let data: any = null;
    try {
        data = await parseOfx(ofx);
        if (data === null) {
            throw 'invalid';
        }
        data = data.OFX.BANKMSGSRSV1.STMTTRNRS;
    } catch (err) {
        throw new KError(`Invalid OFX file: ${err}`);
    }

    assert(data !== null, 'data must be non null');

    // If there is only one account it is an object, else an array of object.
    if (!(data instanceof Array)) {
        data = [data];
    } else if (!data.length) {
        return null;
    }

    let accountId = 0;
    const accounts: Partial<Account>[] = [];
    let transactions: Partial<Transaction>[] = [];

    for (let account of data) {
        account = account.STMTRS;
        if (!account) {
            throw new KError('Cannot find state response message in OFX file.');
        }

        const currencyCode = account.CURDEF;
        if (!currencyCode) {
            throw new KError('Cannot find currency code in OFX file.');
        }

        const accountInfo = account.BANKACCTFROM;

        const vendorAccountId = accountInfo.ACCTID;
        if (!vendorAccountId) {
            throw new KError('Cannot find account id in OFX file.');
        }

        const accountType =
            (accountsTypesMap as any)[accountInfo.ACCTTYPE] || 'account-type.unknown';

        const balance = parseFloat(account.AVAILBAL?.BALAMT) || 0;

        let accountTransactions = account.BANKTRANLIST ? account.BANKTRANLIST.STMTTRN : [];
        if (!(accountTransactions instanceof Array)) {
            accountTransactions = [accountTransactions];
        }

        if (accountTransactions.length) {
            let oldestTransactionDate = Date.now();
            const dateNow = new Date();

            transactions = transactions.concat(
                accountTransactions
                    .map((transaction: any) => {
                        const debitDate = parseOfxDate(transaction.DTPOSTED);
                        let realizationDate = parseOfxDate(transaction.DTUSER);

                        if (!realizationDate) {
                            if (!debitDate) {
                                log.info('Transaction missing both date and debitDate, skipping');
                                return null;
                            }
                            realizationDate = debitDate;
                        }

                        oldestTransactionDate = Math.min(+realizationDate, oldestTransactionDate);

                        return {
                            accountId,
                            date: realizationDate,
                            debitDate,
                            importDate: dateNow,
                            rawLabel: transaction.NAME || transaction.MEMO,
                            label: transaction.MEMO || transaction.NAME,
                            amount: parseFloat(transaction.TRNAMT),
                            type:
                                (transactionsTypesMap as any)[transaction.TRNTYPE] ||
                                transactionsTypesMap.OTHER,
                        };
                    })
                    .filter(
                        (transaction: Partial<Transaction> | null) =>
                            transaction !== null &&
                            typeof transaction.amount !== 'undefined' &&
                            !isNaN(transaction.amount)
                    )
            );

            accounts.push({
                id: accountId,
                vendorAccountId,
                accessId: 0,
                type: accountType,
                initialBalance: balance,
                currency: currencyCode,
                importDate: new Date(oldestTransactionDate),
                label: `OFX imported account - ${accountInfo.ACCTTYPE}`,
            });
        }

        ++accountId;
    }

    return {
        accesses: [
            {
                id: 0,
                vendorId: MANUAL_BANK_NAME,
                login: '',
            },
        ],
        accounts,
        transactions,
    };
}

export const testing = {
    parseOfxDate,
};