@coderoftime/fints 0.0.0-stage → 0.1.0

package/dist/formats/mt940.js

@@ -0,0 +1,297 @@
+import { Amount } from '../core/amount.js';
+import { Transaction } from '../core/transaction.js';
+import { clampedDate, parseSwiftDate } from '../util/dates.js';
+import { FormatError } from '../util/errors.js';
+import { escapeRegExp } from '../util/text.js';
+import { providedReference, SepaPurpose } from './sepa-purpose.js';
+const tagPattern = /^:(\d{2}[A-Z]?):/gm;
+const statementEnd = /\n-\s*$/;
+const trailingNewlines = /\n+$/;
+/** Parser for SWIFT MT940/MT942 statements, including German structured `:86:` fields. */
+export const Mt940 = Object.freeze({
+    /** Parses all transactions; see `parse`. */
+    parseTransactions(text, options = {}) {
+        return Mt940.parse(text, options).flatMap((s) => [...s.transactions]);
+    },
+    /**
+     * Parses all statements.
+     *
+     * Throws `FormatError` if a transaction line (`:61:`) cannot be read or the currency of a transaction is unknown.
+     */
+    parse(text, options = {}) {
+        const status = options.status ?? 'booked';
+        const lines = text.replace(/\r\n/g, '\n').replace(/\r/g, '\n');
+        // Some banks separate lines with `@@` instead of line breaks; where there are line breaks, `@@` is text.
+        const normalized = lines.includes('\n') ? lines : lines.replace(/@@/g, '\n');
+        const tags = [...normalized.matchAll(tagPattern)];
+        const statements = [];
+        let current;
+        tags.forEach((tag, i) => {
+            const end = i + 1 < tags.length ? tags[i + 1].index : normalized.length;
+            const value = normalized
+                .substring(tag.index + tag[0].length, end)
+                .replace(statementEnd, '')
+                .replace(trailingNewlines, '');
+            if (tag[1] === '20' || current === undefined) {
+                if (current !== undefined)
+                    statements.push(current.build());
+                current = new StatementBuilder(status, options.currency);
+            }
+            current.add(tag[1], value);
+        });
+        if (current !== undefined)
+            statements.push(current.build());
+        return statements;
+    },
+});
+const balancePattern = /^([CD])(\d{6})([A-Z]{3})(\d+,\d*)/;
+const currencyPrefix = /^([A-Z]{3})/;
+class StatementBuilder {
+    status;
+    fallbackCurrency;
+    reference;
+    accountId;
+    statementNumber;
+    currency;
+    opening;
+    openingDate;
+    closing;
+    closingDate;
+    transactions = [];
+    /**
+     * The tag added last: a `:86:` right after a `:61:` details the transaction, anywhere else it informs the account
+     * owner about the statement.
+     */
+    previousTag;
+    constructor(status, 
+    /** Currency to use when the statement states none. */
+    fallbackCurrency) {
+        this.status = status;
+        this.fallbackCurrency = fallbackCurrency;
+    }
+    add(tag, value) {
+        switch (tag) {
+            case '20':
+                this.reference = value.trim();
+                break;
+            case '25':
+                this.accountId = value.trim();
+                break;
+            case '28C':
+            case '28':
+                this.statementNumber = value.trim();
+                break;
+            case '60F':
+            case '60M': {
+                const balance = parseBalance(value);
+                if (balance) {
+                    [this.opening, this.openingDate] = balance;
+                    this.currency ??= balance[0].currency;
+                }
+                break;
+            }
+            case '62F':
+            case '62M': {
+                const balance = parseBalance(value);
+                if (balance) {
+                    [this.closing, this.closingDate] = balance;
+                    this.currency ??= balance[0].currency;
+                }
+                break;
+            }
+            case '34F':
+                this.currency ??= currencyPrefix.exec(value.trim())?.[1];
+                break;
+            case '61':
+                this.transactions.push(new TransactionLines(value));
+                break;
+            case '86':
+                if (this.previousTag === '61')
+                    this.transactions.at(-1).details = value;
+                break;
+        }
+        this.previousTag = tag;
+    }
+    build() {
+        const statementCurrency = this.currency ?? this.fallbackCurrency;
+        if (statementCurrency === undefined && this.transactions.length > 0) {
+            throw new FormatError('MT940 statement without currency', this.reference);
+        }
+        return Object.freeze({
+            reference: this.reference,
+            accountId: this.accountId,
+            statementNumber: this.statementNumber,
+            currency: statementCurrency,
+            openingBalance: this.opening,
+            openingDate: this.openingDate,
+            closingBalance: this.closing,
+            closingDate: this.closingDate,
+            transactions: Object.freeze(this.transactions.map((t) => t.toTransaction(statementCurrency, this.status))),
+        });
+    }
+}
+function parseBalance(value) {
+    const m = balancePattern.exec(value.trim());
+    if (!m)
+        return undefined;
+    const amount = Amount.parseDecimal(m[4], m[3]);
+    const date = parseSwiftDate(m[2]);
+    if (date === undefined)
+        throw new FormatError('Invalid balance date', value);
+    return [m[1] === 'D' ? amount.negate() : amount, date];
+}
+/**
+ * Value date, optional booking date (MMDD), debit/credit mark, funds code, amount, transaction type, customer
+ * reference, optional bank reference and supplementary details.
+ */
+const line61 = /^(\d{6})(\d{4})?(RC|RD|C|D)([A-Z])?(\d+,\d*)([NFS][A-Z0-9]{3})([^\n]*?)(?:\/\/([^\n]*))?(?:\n([\s\S]*))?$/;
+/** The `:61:` line of a transaction and its `:86:` details. */
+class TransactionLines {
+    line;
+    details;
+    constructor(line) {
+        this.line = line;
+    }
+    toTransaction(currency, status) {
+        const m = line61.exec(this.line.trim());
+        const valueDate = m ? parseSwiftDate(m[1]) : undefined;
+        if (!m || valueDate === undefined)
+            throw new FormatError('Unreadable MT940 transaction line (:61:)', this.line);
+        const mark = m[3];
+        const amount = Amount.parseDecimal(m[5], currency);
+        const debit = mark === 'D' || mark === 'RC';
+        const customerReference = m[7]?.trim();
+        const bankReference = m[8]?.trim();
+        const d = Details.parse(this.details);
+        return new Transaction({
+            status,
+            bookingDate: this.bookingDate(m[2], valueDate),
+            valueDate,
+            amount: debit ? amount.negate() : amount,
+            isReversal: mark.startsWith('R'),
+            transactionTypeId: m[6],
+            customerReference: customerReference === undefined || customerReference === '' || customerReference === 'NONREF'
+                ? undefined
+                : customerReference,
+            bankReference: bankReference === undefined || bankReference === '' ? undefined : bankReference,
+            transactionCode: d.transactionCode,
+            bookingText: d.bookingText,
+            primaNota: d.primaNota,
+            purpose: d.purpose,
+            counterpartyName: d.name,
+            counterpartyIban: d.iban,
+            counterpartyBic: d.bic,
+            counterpartyAccountNumber: d.accountNumber,
+            counterpartyBankCode: d.bankCode,
+            endToEndId: providedReference(d.sepa.get('EREF')),
+            mandateId: d.sepa.get('MREF'),
+            creditorId: d.sepa.get('CRED'),
+            ultimateCreditor: d.sepa.get('ABWE'),
+            ultimateDebtor: d.sepa.get('ABWA'),
+            purposeCodes: d.sepa,
+        });
+    }
+    /** The booking date `MMDD`, in the year that places it closest to `valueDate` (across a year end). */
+    bookingDate(mmdd, valueDate) {
+        if (mmdd === undefined)
+            return undefined;
+        const month = Number(mmdd.substring(0, 2));
+        const day = Number(mmdd.substring(2, 4));
+        let year = valueDate.getFullYear();
+        if (month === 12 && valueDate.getMonth() === 0)
+            year--;
+        if (month === 1 && valueDate.getMonth() === 11)
+            year++;
+        const date = clampedDate(year, month, day);
+        if (date === undefined)
+            throw new FormatError('Invalid booking date', this.line);
+        return date;
+    }
+}
+/**
+ * Three-digit business transaction code (GVC), then the first subfield: a separator, usually `?`, and its two-digit
+ * number. Text that merely starts with three digits, such as `100 Euro`, is free text.
+ */
+const structuredPattern = /^(\d{3})([^\w\s])\d{2}/;
+const ibanPattern = /^[A-Z]{2}\d{2}[A-Z0-9]+$/;
+const bicPattern = /^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$/;
+/** Subfield pattern for a separator: the separator, a two-digit key, then everything up to the next subfield. */
+function subfieldPattern(separator) {
+    const s = escapeRegExp(separator);
+    return new RegExp(`${s}(\\d{2})((?:(?!${s}\\d{2})[\\s\\S])*)`, 'g');
+}
+/** The German structured `:86:` field: a business transaction code and `?nn` subfields. */
+class Details {
+    transactionCode;
+    bookingText;
+    primaNota;
+    purpose;
+    name;
+    iban;
+    bic;
+    accountNumber;
+    bankCode;
+    sepa = new Map();
+    static parse(raw) {
+        const d = new Details();
+        if (raw === undefined)
+            return d;
+        const text = raw.replace(/\n/g, '');
+        const structured = structuredPattern.exec(text);
+        if (!structured) {
+            // Free text, whose lines are separate phrases; the purpose and its keywords are read from the same text.
+            const free = raw.replace(/\n/g, ' ').trim();
+            d.sepa = SepaPurpose.parse(free);
+            d.purpose = d.sepa.get('SVWZ') ?? (free === '' ? undefined : free);
+            return d;
+        }
+        d.transactionCode = structured[1];
+        const subfields = Details.subfields(text.substring(3), structured[2]);
+        const subfield = (key) => {
+            const value = subfields.get(key)?.trim();
+            return value === undefined || value === '' ? undefined : value;
+        };
+        // Subfields continue each other: they are joined keeping the spaces at their boundaries.
+        const parts = (keys) => keys.map((k) => subfields.get(k)).filter((v) => v !== undefined);
+        d.bookingText = subfield(0);
+        d.primaNota = subfield(10);
+        const purposeParts = parts([20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 60, 61, 62, 63]);
+        const purpose = purposeParts.join('').trim();
+        d.sepa = SepaPurpose.parseParts(purposeParts);
+        d.purpose = d.sepa.get('SVWZ') ?? (purpose === '' ? undefined : purpose);
+        const name = parts([32, 33]).join('').trim();
+        d.name = name === '' ? undefined : name;
+        d.readCounterpartyAccount(subfield(30), subfield(31));
+        d.iban ??= d.sepa.get('IBAN');
+        d.bic ??= d.sepa.get('BIC');
+        return d;
+    }
+    /** The text of each subfield (`?nn` and what follows), by its number; a subfield that appears twice is joined. */
+    static subfields(text, separator) {
+        const subfields = new Map();
+        for (const m of text.matchAll(subfieldPattern(separator))) {
+            const key = Number(m[1]);
+            subfields.set(key, (subfields.get(key) ?? '') + m[2]);
+        }
+        return subfields;
+    }
+    /**
+     * Takes the counterparty's account from subfields 30 (bank) and 31 (account): IBAN and BIC, or account number and
+     * bank code.
+     */
+    readCounterpartyAccount(bank, account) {
+        if (account !== undefined && ibanPattern.test(account)) {
+            this.iban = account;
+            this.bic = bank;
+            return;
+        }
+        this.accountNumber = account;
+        if (bank !== undefined && bicPattern.test(bank)) {
+            this.bic = bank;
+        }
+        else {
+            this.bankCode = bank;
+        }
+    }
+}
+//# sourceMappingURL=mt940.js.map

package/dist/formats/mt940.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mt940.js","sourceRoot":"","sources":["../../src/formats/mt940.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,WAAW,EAA0B,MAAM,wBAAwB,CAAC;AAC7E,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAgCnE,MAAM,UAAU,GAAG,oBAAoB,CAAC;AACxC,MAAM,YAAY,GAAG,SAAS,CAAC;AAC/B,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC,0FAA0F;AAC1F,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;IACjC,4CAA4C;IAC5C,iBAAiB,CAAC,IAAY,EAAE,UAAwB,EAAE;QACxD,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAY,EAAE,UAAwB,EAAE;QAC5C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,QAAQ,CAAC;QAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC/D,yGAAyG;QACzG,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC7E,MAAM,IAAI,GAAG,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;QAClD,MAAM,UAAU,GAAqB,EAAE,CAAC;QACxC,IAAI,OAAqC,CAAC;QAC1C,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;YACtB,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;YACzE,MAAM,KAAK,GAAG,UAAU;iBACrB,SAAS,CAAC,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC;iBACzC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;iBACzB,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;YACjC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC7C,IAAI,OAAO,KAAK,SAAS;oBAAE,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;gBAC5D,OAAO,GAAG,IAAI,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC3D,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAE,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QACH,IAAI,OAAO,KAAK,SAAS;YAAE,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QAC5D,OAAO,UAAU,CAAC;IACpB,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,cAAc,GAAG,mCAAmC,CAAC;AAC3D,MAAM,cAAc,GAAG,aAAa,CAAC;AAErC,MAAM,gBAAgB;IAkBD;IAEA;IAnBnB,SAAS,CAAqB;IAC9B,SAAS,CAAqB;IAC9B,eAAe,CAAqB;IACpC,QAAQ,CAAqB;IAC7B,OAAO,CAAqB;IAC5B,WAAW,CAAmB;IAC9B,OAAO,CAAqB;IAC5B,WAAW,CAAmB;IACrB,YAAY,GAAuB,EAAE,CAAC;IAE/C;;;OAGG;IACK,WAAW,CAAqB;IAExC,YACmB,MAAyB;IAC1C,sDAAsD;IACrC,gBAAoC;QAFpC,WAAM,GAAN,MAAM,CAAmB;QAEzB,qBAAgB,GAAhB,gBAAgB,CAAoB;IACpD,CAAC;IAEJ,GAAG,CAAC,GAAW,EAAE,KAAa;QAC5B,QAAQ,GAAG,EAAE,CAAC;YACZ,KAAK,IAAI;gBACP,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;gBAC9B,MAAM;YACR,KAAK,IAAI;gBACP,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;gBAC9B,MAAM;YACR,KAAK,KAAK,CAAC;YACX,KAAK,IAAI;gBACP,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;gBACpC,MAAM;YACR,KAAK,KAAK,CAAC;YACX,KAAK,KAAK,CAAC,CAAC,CAAC;gBACX,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;gBACpC,IAAI,OAAO,EAAE,CAAC;oBACZ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC;oBAC3C,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;gBACxC,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,KAAK,CAAC;YACX,KAAK,KAAK,CAAC,CAAC,CAAC;gBACX,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;gBACpC,IAAI,OAAO,EAAE,CAAC;oBACZ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC;oBAC3C,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;gBACxC,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,KAAK;gBACR,IAAI,CAAC,QAAQ,KAAK,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACzD,MAAM;YACR,KAAK,IAAI;gBACP,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;gBACpD,MAAM;YACR,KAAK,IAAI;gBACP,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI;oBAAE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC,OAAO,GAAG,KAAK,CAAC;gBACzE,MAAM;QACV,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;IACzB,CAAC;IAED,KAAK;QACH,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,gBAAgB,CAAC;QACjE,IAAI,iBAAiB,KAAK,SAAS,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpE,MAAM,IAAI,WAAW,CAAC,kCAAkC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5E,CAAC;QACD,OAAO,MAAM,CAAC,MAAM,CAAC;YACnB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,QAAQ,EAAE,iBAAiB;YAC3B,cAAc,EAAE,IAAI,CAAC,OAAO;YAC5B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,cAAc,EAAE,IAAI,CAAC,OAAO;YAC5B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,iBAAkB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;SAC5G,CAAC,CAAC;IACL,CAAC;CACF;AAED,SAAS,YAAY,CAAC,KAAa;IACjC,MAAM,CAAC,GAAG,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IAC5C,IAAI,CAAC,CAAC;QAAE,OAAO,SAAS,CAAC;IACzB,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAE,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC;IACnC,IAAI,IAAI,KAAK,SAAS;QAAE,MAAM,IAAI,WAAW,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC;IAC7E,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AACzD,CAAC;AAED;;;GAGG;AACH,MAAM,MAAM,GACV,2GAA2G,CAAC;AAE9G,+DAA+D;AAC/D,MAAM,gBAAgB;IAGC;IAFrB,OAAO,CAAqB;IAE5B,YAAqB,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAErC,aAAa,CAAC,QAAgB,EAAE,MAAyB;QACvD,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QACxC,MAAM,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACxD,IAAI,CAAC,CAAC,IAAI,SAAS,KAAK,SAAS;YAAE,MAAM,IAAI,WAAW,CAAC,0CAA0C,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAChH,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC;QACnB,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAE,EAAE,QAAQ,CAAC,CAAC;QACpD,MAAM,KAAK,GAAG,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,IAAI,CAAC;QAC5C,MAAM,iBAAiB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;QACvC,MAAM,aAAa,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;QACnC,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtC,OAAO,IAAI,WAAW,CAAC;YACrB,MAAM;YACN,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC;YAC9C,SAAS;YACT,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM;YACxC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAChC,iBAAiB,EAAE,CAAC,CAAC,CAAC,CAAC;YACvB,iBAAiB,EACf,iBAAiB,KAAK,SAAS,IAAI,iBAAiB,KAAK,EAAE,IAAI,iBAAiB,KAAK,QAAQ;gBAC3F,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,iBAAiB;YACvB,aAAa,EAAE,aAAa,KAAK,SAAS,IAAI,aAAa,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa;YAC9F,eAAe,EAAE,CAAC,CAAC,eAAe;YAClC,WAAW,EAAE,CAAC,CAAC,WAAW;YAC1B,SAAS,EAAE,CAAC,CAAC,SAAS;YACtB,OAAO,EAAE,CAAC,CAAC,OAAO;YAClB,gBAAgB,EAAE,CAAC,CAAC,IAAI;YACxB,gBAAgB,EAAE,CAAC,CAAC,IAAI;YACxB,eAAe,EAAE,CAAC,CAAC,GAAG;YACtB,yBAAyB,EAAE,CAAC,CAAC,aAAa;YAC1C,oBAAoB,EAAE,CAAC,CAAC,QAAQ;YAChC,UAAU,EAAE,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACjD,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;YAC7B,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;YAC9B,gBAAgB,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;YACpC,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;YAClC,YAAY,EAAE,CAAC,CAAC,IAAI;SACrB,CAAC,CAAC;IACL,CAAC;IAED,sGAAsG;IAC9F,WAAW,CAAC,IAAwB,EAAE,SAAe;QAC3D,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QACzC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACzC,IAAI,IAAI,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;QACnC,IAAI,KAAK,KAAK,EAAE,IAAI,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,CAAC;QACvD,IAAI,KAAK,KAAK,CAAC,IAAI,SAAS,CAAC,QAAQ,EAAE,KAAK,EAAE;YAAE,IAAI,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;QAC3C,IAAI,IAAI,KAAK,SAAS;YAAE,MAAM,IAAI,WAAW,CAAC,sBAAsB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACjF,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,iBAAiB,GAAG,wBAAwB,CAAC;AACnD,MAAM,WAAW,GAAG,0BAA0B,CAAC;AAC/C,MAAM,UAAU,GAAG,qCAAqC,CAAC;AAEzD,iHAAiH;AACjH,SAAS,eAAe,CAAC,SAAiB;IACxC,MAAM,CAAC,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IAClC,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC;AACtE,CAAC;AAED,2FAA2F;AAC3F,MAAM,OAAO;IACX,eAAe,CAAqB;IACpC,WAAW,CAAqB;IAChC,SAAS,CAAqB;IAC9B,OAAO,CAAqB;IAC5B,IAAI,CAAqB;IACzB,IAAI,CAAqB;IACzB,GAAG,CAAqB;IACxB,aAAa,CAAqB;IAClC,QAAQ,CAAqB;IAC7B,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEjC,MAAM,CAAC,KAAK,CAAC,GAAuB;QAClC,MAAM,CAAC,GAAG,IAAI,OAAO,EAAE,CAAC;QACxB,IAAI,GAAG,KAAK,SAAS;YAAE,OAAO,CAAC,CAAC;QAChC,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACpC,MAAM,UAAU,GAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,yGAAyG;YACzG,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YAC5C,CAAC,CAAC,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACjC,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACnE,OAAO,CAAC,CAAC;QACX,CAAC;QACD,CAAC,CAAC,eAAe,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAClC,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAE,CAAC,CAAC;QACvE,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAsB,EAAE;YACnD,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC;YACzC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;QACjE,CAAC,CAAC;QACF,yFAAyF;QACzF,MAAM,KAAK,GAAG,CAAC,IAAc,EAAY,EAAE,CACzC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;QAEhF,CAAC,CAAC,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC,CAAC,SAAS,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC3B,MAAM,YAAY,GAAG,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QACrF,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAC7C,CAAC,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QAC9C,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACzE,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAC7C,CAAC,CAAC,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;QACxC,CAAC,CAAC,uBAAuB,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;QACtD,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,OAAO,CAAC,CAAC;IACX,CAAC;IAED,kHAAkH;IAC1G,MAAM,CAAC,SAAS,CAAC,IAAY,EAAE,SAAiB;QACtD,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC5C,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YAC1D,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACzB,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACK,uBAAuB,CAAC,IAAwB,EAAE,OAA2B;QACnF,IAAI,OAAO,KAAK,SAAS,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACvD,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;YACpB,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;YAChB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC;QAC7B,IAAI,IAAI,KAAK,SAAS,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACvB,CAAC;IACH,CAAC;CACF"}

package/dist/formats/readers.d.ts

@@ -0,0 +1,11 @@
+import type { Transaction } from '../core/transaction.js';
+/**
+ * The transactions in MT940 data: the `booked` parts joined, since a statement may continue on the next page, then the
+ * `pending` ones (MT942).
+ *
+ * `currency` applies to statements that do not state one; throws `FormatError` if both are missing.
+ */
+export declare function mt940Transactions(booked: readonly Uint8Array[], pending: readonly Uint8Array[], currency: string | undefined): Transaction[];
+/** The transactions in camt documents; each document stands on its own. */
+export declare function camtTransactions(booked: readonly Uint8Array[], pending: readonly Uint8Array[]): Transaction[];
+//# sourceMappingURL=readers.d.ts.map

package/dist/formats/readers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readers.d.ts","sourceRoot":"","sources":["../../src/formats/readers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAM1D;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,SAAS,UAAU,EAAE,EAC7B,OAAO,EAAE,SAAS,UAAU,EAAE,EAC9B,QAAQ,EAAE,MAAM,GAAG,SAAS,GAC3B,WAAW,EAAE,CAKf;AA4BD,2EAA2E;AAC3E,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,SAAS,UAAU,EAAE,EAAE,OAAO,EAAE,SAAS,UAAU,EAAE,GAAG,WAAW,EAAE,CAK7G"}

package/dist/formats/readers.js

@@ -0,0 +1,47 @@
+import { BytesBuilder } from '../util/bytes.js';
+import { decodeBankText, decodeXmlText } from '../util/text.js';
+import { Camt } from './camt.js';
+import { Mt940 } from './mt940.js';
+/**
+ * The transactions in MT940 data: the `booked` parts joined, since a statement may continue on the next page, then the
+ * `pending` ones (MT942).
+ *
+ * `currency` applies to statements that do not state one; throws `FormatError` if both are missing.
+ */
+export function mt940Transactions(booked, pending, currency) {
+    return [
+        ...Mt940.parseTransactions(joinedMt940(booked), { currency }),
+        ...Mt940.parseTransactions(joinedMt940(pending), { currency, status: 'pending' }),
+    ];
+}
+const lineFeed = 0x0a;
+const carriageReturn = 0x0d;
+const atSign = 0x40;
+/**
+ * The MT940 `parts` as one text.
+ *
+ * Each part ends a line before the next one follows, since the parser finds fields at the start of a line and a bank
+ * need not end its pages with a line break. Banks that separate lines with `@@` get that separator.
+ */
+function joinedMt940(parts) {
+    const pages = parts.filter((part) => part.length > 0);
+    const atSigns = !pages.some((p) => p.includes(lineFeed) || p.includes(carriageReturn));
+    const endsLine = (page) => atSigns
+        ? page.length >= 2 && page[page.length - 1] === atSign && page[page.length - 2] === atSign
+        : page.at(-1) === lineFeed || page.at(-1) === carriageReturn;
+    const bytes = new BytesBuilder();
+    pages.forEach((page, i) => {
+        if (i > 0 && !endsLine(pages[i - 1]))
+            bytes.add(atSigns ? [atSign, atSign] : [lineFeed]);
+        bytes.add(page);
+    });
+    return decodeBankText(bytes.takeBytes());
+}
+/** The transactions in camt documents; each document stands on its own. */
+export function camtTransactions(booked, pending) {
+    return [
+        ...booked.flatMap((document) => Camt.parseTransactions(decodeXmlText(document))),
+        ...pending.flatMap((document) => Camt.parseTransactions(decodeXmlText(document), 'pending')),
+    ];
+}
+//# sourceMappingURL=readers.js.map

package/dist/formats/readers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readers.js","sourceRoot":"","sources":["../../src/formats/readers.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAA6B,EAC7B,OAA8B,EAC9B,QAA4B;IAE5B,OAAO;QACL,GAAG,KAAK,CAAC,iBAAiB,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC;QAC7D,GAAG,KAAK,CAAC,iBAAiB,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;KAClF,CAAC;AACJ,CAAC;AAED,MAAM,QAAQ,GAAG,IAAI,CAAC;AACtB,MAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,MAAM,MAAM,GAAG,IAAI,CAAC;AAEpB;;;;;GAKG;AACH,SAAS,WAAW,CAAC,KAA4B;IAC/C,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC;IACvF,MAAM,QAAQ,GAAG,CAAC,IAAgB,EAAW,EAAE,CAC7C,OAAO;QACL,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,MAAM;QAC1F,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,cAAc,CAAC;IAEjE,MAAM,KAAK,GAAG,IAAI,YAAY,EAAE,CAAC;IACjC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;QACxB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC1F,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;IACH,OAAO,cAAc,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC;AAC3C,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,gBAAgB,CAAC,MAA6B,EAAE,OAA8B;IAC5F,OAAO;QACL,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC;QAChF,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;KAC7F,CAAC;AACJ,CAAC"}

package/dist/formats/sepa-purpose.d.ts

@@ -0,0 +1,22 @@
+/** `reference`, or `undefined` if it is missing or the filler for a reference the payer did not give. */
+export declare function providedReference(reference: string | undefined): string | undefined;
+/** Parser for the SEPA keywords in a purpose text. */
+export declare const SepaPurpose: Readonly<{
+    /**
+     * Splits `purpose` into its SEPA keywords (EREF, KREF, MREF, CRED, SVWZ, …) and their values.
+     *
+     * A keyword counts unless a capital letter comes right before it, so `XEREF+` does not open an EREF value. After a
+     * digit or a small letter it does: a purpose line cut at 35 characters is joined to the next one without a space, so
+     * `…4711EREF+` may be where one line ends and the next begins.
+     */
+    parse(purpose: string): Map<string, string>;
+    /**
+     * Like `parse` for a purpose the bank sends in `parts`, such as the MT940 subfields `?20` to `?29`, which continue
+     * each other without a separator.
+     *
+     * A keyword also counts at the start of a part, where the previous value may end in a capital letter, as in
+     * `EREF+NOTPROVIDED` followed by a part `MREF+…`.
+     */
+    parseParts(parts: Iterable<string>): Map<string, string>;
+}>;
+//# sourceMappingURL=sepa-purpose.d.ts.map

package/dist/formats/sepa-purpose.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sepa-purpose.d.ts","sourceRoot":"","sources":["../../src/formats/sepa-purpose.ts"],"names":[],"mappings":"AAqBA,yGAAyG;AACzG,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAEnF;AAID,sDAAsD;AACtD,eAAO,MAAM,WAAW;IACtB;;;;;;OAMG;mBACY,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAI3C;;;;;;OAMG;sBACe,QAAQ,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;EASxD,CAAC"}

package/dist/formats/sepa-purpose.js

@@ -0,0 +1,68 @@
+/** SEPA keywords German banks put into the purpose text, each followed by `+`. */
+const keywords = [
+    'EREF',
+    'KREF',
+    'MREF',
+    'CRED',
+    'DEBT',
+    'COAM',
+    'OAMT',
+    'SVWZ',
+    'ABWA',
+    'ABWE',
+    'IBAN',
+    'BIC',
+    'PURP',
+    'SQTP',
+];
+/** The filler SEPA prescribes where the payer gave no end-to-end reference. */
+const notProvided = 'NOTPROVIDED';
+/** `reference`, or `undefined` if it is missing or the filler for a reference the payer did not give. */
+export function providedReference(reference) {
+    return reference === notProvided ? undefined : reference;
+}
+const keywordPattern = new RegExp(`(${keywords.join('|')})\\+`, 'g');
+/** Parser for the SEPA keywords in a purpose text. */
+export const SepaPurpose = Object.freeze({
+    /**
+     * Splits `purpose` into its SEPA keywords (EREF, KREF, MREF, CRED, SVWZ, …) and their values.
+     *
+     * A keyword counts unless a capital letter comes right before it, so `XEREF+` does not open an EREF value. After a
+     * digit or a small letter it does: a purpose line cut at 35 characters is joined to the next one without a space, so
+     * `…4711EREF+` may be where one line ends and the next begins.
+     */
+    parse(purpose) {
+        return split(purpose, new Set());
+    },
+    /**
+     * Like `parse` for a purpose the bank sends in `parts`, such as the MT940 subfields `?20` to `?29`, which continue
+     * each other without a separator.
+     *
+     * A keyword also counts at the start of a part, where the previous value may end in a capital letter, as in
+     * `EREF+NOTPROVIDED` followed by a part `MREF+…`.
+     */
+    parseParts(parts) {
+        let text = '';
+        const partStarts = new Set();
+        for (const part of parts) {
+            partStarts.add(text.length);
+            text += part;
+        }
+        return split(text, partStarts);
+    },
+});
+function split(purpose, partStarts) {
+    const atWordStart = (index) => index === 0 || partStarts.has(index) || !isCapitalLetter(purpose, index - 1);
+    const matches = [...purpose.matchAll(keywordPattern)].filter((m) => atWordStart(m.index));
+    const result = new Map();
+    matches.forEach((m, i) => {
+        const end = i + 1 < matches.length ? matches[i + 1].index : purpose.length;
+        result.set(m[1], purpose.substring(m.index + m[0].length, end).trim());
+    });
+    return result;
+}
+function isCapitalLetter(text, index) {
+    const c = text.charCodeAt(index);
+    return c >= 0x41 && c <= 0x5a;
+}
+//# sourceMappingURL=sepa-purpose.js.map

package/dist/formats/sepa-purpose.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sepa-purpose.js","sourceRoot":"","sources":["../../src/formats/sepa-purpose.ts"],"names":[],"mappings":"AAAA,kFAAkF;AAClF,MAAM,QAAQ,GAAG;IACf,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,KAAK;IACL,MAAM;IACN,MAAM;CACP,CAAC;AAEF,+EAA+E;AAC/E,MAAM,WAAW,GAAG,aAAa,CAAC;AAElC,yGAAyG;AACzG,MAAM,UAAU,iBAAiB,CAAC,SAA6B;IAC7D,OAAO,SAAS,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;AAC3D,CAAC;AAED,MAAM,cAAc,GAAG,IAAI,MAAM,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAErE,sDAAsD;AACtD,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC;IACvC;;;;;;OAMG;IACH,KAAK,CAAC,OAAe;QACnB,OAAO,KAAK,CAAC,OAAO,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,KAAuB;QAChC,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;QACrC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5B,IAAI,IAAI,IAAI,CAAC;QACf,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACjC,CAAC;CACF,CAAC,CAAC;AAEH,SAAS,KAAK,CAAC,OAAe,EAAE,UAA+B;IAC7D,MAAM,WAAW,GAAG,CAAC,KAAa,EAAW,EAAE,CAC7C,KAAK,KAAK,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;IAC/E,MAAM,OAAO,GAAG,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1F,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACvB,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QAC5E,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAE,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,eAAe,CAAC,IAAY,EAAE,KAAa;IAClD,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACjC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC;AAChC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+/**
+ * FinTS 3.0 client for German banks: accounts, balances and transactions with PIN/TAN, PSD2 strong customer
+ * authentication and decoupled app approval.
+ *
+ * Start with `FinTs3Client`. The public API is what this file names; everything else is internal.
+ *
+ * @packageDocumentation
+ */
+export { Account, AccountDataStatus, type AccountCategory, type AccountInit } from './core/account.js';
+export { Amount } from './core/amount.js';
+export { Balance, type BalanceInit } from './core/balance.js';
+export { BankInfo, BankMessage } from './core/bank-info.js';
+export type { BankMessageHandler, FinTsClient, FinTsClientOptions, MessageDirection, MessageLogger, TransactionQuery, WarningHandler, } from './core/client.js';
+export { FinTsConfig, type FinTsConfigInit } from './core/config.js';
+export { FinTsBankError, FinTsDecoupledTimeoutError, FinTsDialogAbortedError, FinTsError, FinTsLoginDataChangedError, FinTsPinError, FinTsProtocolError, FinTsStateError, FinTsTanCancelledError, FinTsTanError, FinTsTransportError, FinTsUnsupportedError, } from './core/errors.js';
+export { FeedbackCodes, FinTsFeedback } from './core/feedback.js';
+export { Transaction, type TransactionFormat, type TransactionInit, type TransactionStatus, } from './core/transaction.js';
+export { HttpTransport, type FinTsTransport, type HttpTransportOptions } from './core/transport.js';
+export { Camt } from './formats/camt.js';
+export { Mt940, type Mt940Options, type Mt940Statement } from './formats/mt940.js';
+export { SepaPurpose } from './formats/sepa-purpose.js';
+export { TanAnswer, TanChallenge, type TanCallback, type TanChallengeInit, type TanMediumSelector, type TanMethodSelector, } from './tan/challenge.js';
+export { FlickerCode, type HhdVersion } from './tan/flicker.js';
+export { TanImage } from './tan/tan-image.js';
+export { TanMedium, TanMethod, type TanMediumInit, type TanMediumRequirement, type TanMediumStatus, type TanMethodInit, } from './tan/tan-models.js';
+export { FormatError } from './util/errors.js';
+export { FinTs3Client, type FinTs3ClientInit } from './v3/client.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,KAAK,eAAe,EAAE,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACvG,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAC5D,YAAY,EACV,kBAAkB,EAClB,WAAW,EACX,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EAChB,cAAc,GACf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACrE,OAAO,EACL,cAAc,EACd,0BAA0B,EAC1B,uBAAuB,EACvB,UAAU,EACV,0BAA0B,EAC1B,aAAa,EACb,kBAAkB,EAClB,eAAe,EACf,sBAAsB,EACtB,aAAa,EACb,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EACL,WAAW,EACX,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,iBAAiB,GACvB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAE,KAAK,cAAc,EAAE,KAAK,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AACpG,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,KAAK,YAAY,EAAE,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACnF,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EACL,SAAS,EACT,YAAY,EACZ,KAAK,WAAW,EAChB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,GACvB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EACL,SAAS,EACT,SAAS,EACT,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,aAAa,GACnB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,27 @@
+/**
+ * FinTS 3.0 client for German banks: accounts, balances and transactions with PIN/TAN, PSD2 strong customer
+ * authentication and decoupled app approval.
+ *
+ * Start with `FinTs3Client`. The public API is what this file names; everything else is internal.
+ *
+ * @packageDocumentation
+ */
+export { Account, AccountDataStatus } from './core/account.js';
+export { Amount } from './core/amount.js';
+export { Balance } from './core/balance.js';
+export { BankInfo, BankMessage } from './core/bank-info.js';
+export { FinTsConfig } from './core/config.js';
+export { FinTsBankError, FinTsDecoupledTimeoutError, FinTsDialogAbortedError, FinTsError, FinTsLoginDataChangedError, FinTsPinError, FinTsProtocolError, FinTsStateError, FinTsTanCancelledError, FinTsTanError, FinTsTransportError, FinTsUnsupportedError, } from './core/errors.js';
+export { FeedbackCodes, FinTsFeedback } from './core/feedback.js';
+export { Transaction, } from './core/transaction.js';
+export { HttpTransport } from './core/transport.js';
+export { Camt } from './formats/camt.js';
+export { Mt940 } from './formats/mt940.js';
+export { SepaPurpose } from './formats/sepa-purpose.js';
+export { TanAnswer, TanChallenge, } from './tan/challenge.js';
+export { FlickerCode } from './tan/flicker.js';
+export { TanImage } from './tan/tan-image.js';
+export { TanMedium, TanMethod, } from './tan/tan-models.js';
+export { FormatError } from './util/errors.js';
+export { FinTs3Client } from './v3/client.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAA0C,MAAM,mBAAmB,CAAC;AACvG,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAoB,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAU5D,OAAO,EAAE,WAAW,EAAwB,MAAM,kBAAkB,CAAC;AACrE,OAAO,EACL,cAAc,EACd,0BAA0B,EAC1B,uBAAuB,EACvB,UAAU,EACV,0BAA0B,EAC1B,aAAa,EACb,kBAAkB,EAClB,eAAe,EACf,sBAAsB,EACtB,aAAa,EACb,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EACL,WAAW,GAIZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAkD,MAAM,qBAAqB,CAAC;AACpG,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,KAAK,EAA0C,MAAM,oBAAoB,CAAC;AACnF,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EACL,SAAS,EACT,YAAY,GAKb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAmB,MAAM,kBAAkB,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EACL,SAAS,EACT,SAAS,GAKV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAyB,MAAM,gBAAgB,CAAC"}

package/dist/session/app-approval.d.ts

@@ -0,0 +1,60 @@
+import { type TanAnswer, type TanChallenge } from '../tan/challenge.js';
+import type { TanMethod } from '../tan/tan-models.js';
+import type { Approval, BankResponse } from './protocol.js';
+/** Shows a challenge and returns the user's answer. */
+export type AskUser = (challenge: TanChallenge) => Promise<TanAnswer>;
+/** Waits for `delayMs`, or until `interrupt` settles. */
+export type Pause = (delayMs: number, interrupt?: Promise<unknown>) => Promise<void>;
+/** What an `AppApprovalWait` needs: `ask` shows a challenge, `pause` waits, `receive` takes in each status response. */
+export interface AppApprovalHooks<R> {
+    readonly ask: AskUser;
+    readonly pause: Pause;
+    /** Takes in each status response; throws if it reports errors. */
+    readonly receive: (response: R) => void;
+}
+/**
+ * Waits for the user to approve a message in the banking app, and for the bank to confirm it (PIN/TAN B.4.2.2).
+ *
+ * The bank's parameters decide who triggers the status requests:
+ * - The client polls by itself while the callback shows the instructions (`PollingWhileShown`) where the bank allows
+ *   automatic status requests and announces no push message (3957), and also where the user cannot report the
+ *   approval: then polling is the one way left to complete it, whatever the other parameters say (step 2a).
+ * - Otherwise the client asks after each report of the user (`PollingAfterReports`), which stands in for the push
+ *   message the client cannot receive.
+ *
+ * The bank's limit on status requests holds either way, and two requests are at least a second apart. One instance
+ * handles one `Approval`; `run` may be called once. A failure of `ask` or `pause`, such as a closed client, ends the
+ * wait.
+ */
+export declare function appApprovalWait<R extends BankResponse>(approval: Approval<R>, hooks: AppApprovalHooks<R>): AppApprovalWait<R>;
+export declare abstract class AppApprovalWait<R extends BankResponse> {
+    protected readonly approval: Approval<R>;
+    protected readonly hooks: AppApprovalHooks<R>;
+    private requests;
+    /** The time the client waited by itself, which counts towards the longest wait. */
+    protected waitedMs: number;
+    constructor(approval: Approval<R>, hooks: AppApprovalHooks<R>);
+    /**
+     * Returns the bank's response once the approval is through. Throws `FinTsTanCancelledError` if the user cancels and
+     * `FinTsDecoupledTimeoutError` if the approval takes too long.
+     */
+    abstract run(): Promise<R>;
+    protected get method(): TanMethod;
+    /** Whether the user may report the approval (PIN/TAN, "Manuelle Bestätigung möglich"). */
+    protected get userConfirms(): boolean;
+    protected get pollIntervalMs(): number;
+    protected get firstPollDelayMs(): number;
+    /**
+     * Sends the next status request and returns the answer, once `receive` has taken it in.
+     *
+     * Throws if the answer reports errors, and `FinTsDecoupledTimeoutError` if the approval is still pending after as
+     * many requests as the bank allows, or after the longest wait.
+     */
+    protected requestStatus(): Promise<R>;
+    /**
+     * `challenge` as the next prompt, with the new instructions of `pending`, the last status answer, where it gives any
+     * (PIN/TAN B.4.2.2.1, step 2b).
+     */
+    protected nextPrompt(challenge: TanChallenge, pending: R): TanChallenge;
+}
+//# sourceMappingURL=app-approval.d.ts.map

package/dist/session/app-approval.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-approval.d.ts","sourceRoot":"","sources":["../../src/session/app-approval.ts"],"names":[],"mappings":"AAEA,OAAO,EAA6B,KAAK,SAAS,EAAE,KAAK,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAGtD,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAY5D,uDAAuD;AACvD,MAAM,MAAM,OAAO,GAAG,CAAC,SAAS,EAAE,YAAY,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;AAEtE,yDAAyD;AACzD,MAAM,MAAM,KAAK,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAErF,wHAAwH;AACxH,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,kEAAkE;IAClE,QAAQ,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,IAAI,CAAC;CACzC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,YAAY,EACpD,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,EACrB,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,GACzB,eAAe,CAAC,CAAC,CAAC,CAIpB;AAED,8BAAsB,eAAe,CAAC,CAAC,SAAS,YAAY;IAOxD,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;IACxC,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAP/C,OAAO,CAAC,QAAQ,CAAK;IAErB,mFAAmF;IACnF,SAAS,CAAC,QAAQ,SAAK;gBAGF,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,EACrB,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAG/C;;;OAGG;IACH,QAAQ,CAAC,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC;IAE1B,SAAS,KAAK,MAAM,IAAI,SAAS,CAEhC;IAED,0FAA0F;IAC1F,SAAS,KAAK,YAAY,IAAI,OAAO,CAEpC;IAED,SAAS,KAAK,cAAc,IAAI,MAAM,CAMrC;IAED,SAAS,KAAK,gBAAgB,IAAI,MAAM,CAEvC;IAED;;;;;OAKG;cACa,aAAa,IAAI,OAAO,CAAC,CAAC,CAAC;IAe3C;;;OAGG;IACH,SAAS,CAAC,UAAU,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,GAAG,YAAY;CAGxE"}