@coderoftime/fints 0.0.0-stage → 0.1.0

package/dist/v3/protocol.js

@@ -0,0 +1,263 @@
+// Internal to the package, and named after the FinTS specification. Documentation is where the meaning is not evident.
+import { requirePin } from '../core/config.js';
+import { FinTsError, FinTsTransportError, FinTsUnsupportedError } from '../core/errors.js';
+import { hasErrors } from '../core/feedback.js';
+import { camtTransactions, mt940Transactions } from '../formats/readers.js';
+import { BankConnection, checkMessageSize } from '../session/bank-connection.js';
+import { LoginGuard } from '../session/login-guard.js';
+import { offeredVersion, requireBankParameters } from '../session/parameter-data.js';
+import { balanceQuery, checkBeforeSigning, chooseTransactions, } from '../session/protocol.js';
+import { invalidArgument } from '../util/errors.js';
+import { readOptionalString } from '../util/json.js';
+import { decodeBankText } from '../util/text.js';
+import { FinTs3Dialog } from './dialog.js';
+import { buildMessage, decodeTransport, encodeTransport, IncomingMessage3 } from './message.js';
+import { Bpd3, decodeSegments, encodeSegments, Upd3 } from './parameters.js';
+import { balanceAccount, parseBalance, parseSepaAccounts, parseTanMedia, Segments } from './segments.js';
+import { isLatin1 } from './syntax.js';
+/** Customer ID the specification reserves for anonymous dialogs. */
+const anonymousCustomerId = '9999999999';
+/** Longest product ID (Produktbezeichnung) and product version HKVVB takes. */
+const maxProductIdLength = 25;
+const maxProductVersionLength = 5;
+function requireLatin1(text, name) {
+    // The message leaves out the value, which may be the PIN.
+    if (!isLatin1(text))
+        throw invalidArgument(`${name} contains characters FinTS 3.0 cannot send (ISO 8859-1 only)`);
+    return text;
+}
+function requireMaxLength(text, maxLength, name) {
+    if (text.length > maxLength)
+        throw invalidArgument(`At most ${maxLength} characters in FinTS 3.0`, name);
+}
+function requireSendable(config) {
+    requireLatin1(config.userId, 'userId');
+    requireLatin1(config.customerId, 'customerId');
+    requireLatin1(config.productId, 'productId');
+    requireLatin1(config.productVersion, 'productVersion');
+    // Cut short, the product would be one the bank does not know.
+    requireMaxLength(config.productId, maxProductIdLength, 'productId');
+    requireMaxLength(config.productVersion, maxProductVersionLength, 'productVersion');
+    return config;
+}
+/** The segments of `type` in all `pages`. */
+function all(pages, type) {
+    return pages.flatMap((p) => p.findAll(type));
+}
+/** FinTS 3.0 messages and business transactions (HBCI segment syntax, PIN/TAN security). */
+export class FinTs3Protocol {
+    config;
+    pin;
+    connection;
+    loginGuard = new LoginGuard();
+    /** Customer system ID the bank assigned in the synchronization. */
+    systemId;
+    bpd;
+    upd;
+    /**
+     * Throws `TypeError` if the PIN is empty, if the PIN or login data contain characters FinTS 3.0 cannot send (ISO
+     * 8859-1 only), or the product ID or version is longer than its field in HKVVB.
+     */
+    constructor(config, pin, transport, logger) {
+        this.config = requireSendable(config);
+        this.pin = requireLatin1(requirePin(pin), 'pin');
+        this.connection = new BankConnection(config.url, transport, logger);
+    }
+    get bankParameters() {
+        return this.bpd;
+    }
+    get userParameters() {
+        return this.upd;
+    }
+    /** Dialogs cannot start without the customer system ID. */
+    get synchronization() {
+        return this.systemId === undefined ? 'required' : 'none';
+    }
+    forgetSystemId() {
+        const had = this.systemId !== undefined;
+        this.systemId = undefined;
+        return had;
+    }
+    initSegments(systemId, anonymous = false) {
+        return [
+            Segments.identification({
+                countryCode: this.config.countryCode,
+                bankCode: this.config.bankCode,
+                customerId: anonymous ? anonymousCustomerId : this.config.customerId,
+                systemId,
+                systemIdRequired: !anonymous,
+            }),
+            Segments.processingPreparation({
+                bpdVersion: this.bpd?.version ?? 0,
+                updVersion: anonymous ? 0 : (this.upd?.version ?? 0),
+                language: this.bpd?.dialogLanguage ?? 0,
+                productId: this.config.productId,
+                productVersion: this.config.productVersion,
+            }),
+        ];
+    }
+    async post(message) {
+        const signing = message.signing;
+        if (signing !== undefined)
+            checkBeforeSigning(this.loginGuard, this.pin, this.bpd);
+        const outgoing = buildMessage({
+            dialogId: message.dialogId,
+            messageNumber: message.number,
+            segments: message.segments,
+            security: signing === undefined
+                ? undefined
+                : {
+                    countryCode: this.config.countryCode,
+                    bankCode: this.config.bankCode,
+                    userId: this.config.userId,
+                    systemId: signing.systemId,
+                    pin: this.pin,
+                    securityFunction: signing.securityFunction,
+                },
+            tan: message.tan,
+        });
+        checkMessageSize(outgoing.bytes.length, this.bpd?.bankInfo.maxMessageSize);
+        this.connection.log('outgoing', () => outgoing.masked);
+        const bytes = decodeTransport(await this.connection.post(encodeTransport(outgoing.bytes), 'text/plain'));
+        this.connection.log('incoming', () => decodeBankText(bytes));
+        return bytes;
+    }
+    keepParameterData(response) {
+        this.keepBankParameters(response);
+        this.upd = Upd3.fromSegments(response.segments, this.config.bankCode, this.config.countryCode) ?? this.upd;
+        this.systemId = response.find('HISYN')?.text(1) ?? this.systemId;
+    }
+    keepBankParameters(response) {
+        this.bpd = Bpd3.fromSegments(response.segments, this.config.bankCode) ?? this.bpd;
+    }
+    /** Keeps the bank parameter data of an anonymous dialog, and nothing that belongs to a user. */
+    async fetchBankParametersAnonymously() {
+        const response = await this.requestBankParametersAnonymously();
+        this.keepBankParameters(response);
+        return response;
+    }
+    /**
+     * Asks for the bank parameter data in an anonymous dialog that announces strong customer authentication; a bank that
+     * rejects the announcement, with a return code or by failing on it, is asked again without it.
+     *
+     * A timeout or a broken connection is not a reason to ask again: it would only double the wait.
+     */
+    async requestBankParametersAnonymously() {
+        let announced;
+        try {
+            announced = await this.anonymousDialog(true);
+        }
+        catch (error) {
+            if (error instanceof FinTsTransportError && error.statusCode === undefined)
+                throw error;
+            if (!(error instanceof FinTsError))
+                throw error;
+            return this.anonymousDialog(false);
+        }
+        if (!hasErrors(announced.feedback) || announced.find('HIBPA') !== undefined)
+            return announced;
+        return this.anonymousDialog(false);
+    }
+    async anonymousDialog(announceSca) {
+        const dialog = FinTs3Dialog.anonymous(this);
+        try {
+            return await dialog.requestBankParameters(announceSca);
+        }
+        finally {
+            await dialog.end();
+        }
+    }
+    newDialog(method, tanMedium) {
+        return FinTs3Dialog.signed(this, method, tanMedium);
+    }
+    combine(first, second) {
+        return IncomingMessage3.combine(first, second);
+    }
+    // --- Business transactions ---
+    version(transaction, implemented, options = {}) {
+        return offeredVersion(this.bpd, this.upd, transaction, new Set(implemented), options);
+    }
+    tanMedia() {
+        const version = this.version('HKTAB', [4, 5]);
+        if (version === undefined)
+            return undefined;
+        return {
+            order: () => Segments.tanMedia(version),
+            read: (pages) => all(pages, 'HITAB').flatMap(parseTanMedia),
+        };
+    }
+    sepaAccounts() {
+        const version = this.version('HKSPA', [1, 2, 3], { requiresEntry: true });
+        if (version === undefined)
+            return undefined;
+        return {
+            order: (continuation) => Segments.sepaAccounts(version, continuation),
+            read: (pages) => all(pages, 'HISPA').flatMap((s) => parseSepaAccounts(s, this.config.countryCode, this.config.bankCode)),
+        };
+    }
+    balance(account) {
+        const version = this.version('HKSAL', [6, 7, 8], { account });
+        if (version === undefined) {
+            throw new FinTsUnsupportedError('The bank reports no balance (HKSAL) for this account');
+        }
+        return balanceQuery(account, {
+            order: (continuation) => Segments.balance(version, account, continuation),
+            records: (pages) => all(pages, 'HISAL'),
+            accountOf: balanceAccount,
+            read: parseBalance,
+        });
+    }
+    transactions(account, format, from, to) {
+        const request = chooseTransactions(format, account, this.upd, {
+            camt: { name: 'HKCAZ', version: this.version('HKCAZ', [1], { account }) },
+            camtFormats: requireBankParameters(this.bpd).camtFormats,
+            mt940: { name: 'HKKAZ', version: this.version('HKKAZ', [6, 7], { account }) },
+        });
+        const version = request.version;
+        if (request.camt) {
+            return {
+                order: (continuation) => Segments.transactionsCamt(version, account, request.camtFormats, { from, to, continuation }),
+                // The third element group holds the booked documents, the fourth element the pending one.
+                read: (pages) => camtTransactions(all(pages, 'HICAZ').flatMap((s) => s
+                    .group(3)
+                    .filter((d) => !d.isEmpty)
+                    .map((d) => d.bytes)), all(pages, 'HICAZ')
+                    .map((s) => s.binary(4))
+                    .filter((d) => d !== undefined)),
+            };
+        }
+        return {
+            order: (continuation) => Segments.transactionsMt940(version, account, { from, to, continuation }),
+            // The first element holds the booked transactions, the second the pending ones.
+            read: (pages) => mt940Transactions(all(pages, 'HIKAZ')
+                .map((s) => s.binary(1))
+                .filter((d) => d !== undefined), all(pages, 'HIKAZ')
+                .map((s) => s.binary(2))
+                .filter((d) => d !== undefined), request.currency),
+        };
+    }
+    // --- Saved state ---
+    saveState() {
+        return {
+            systemId: this.systemId ?? null,
+            bpd: this.bpd === undefined ? null : encodeSegments(this.bpd.segments),
+            upd: this.upd === undefined ? null : encodeSegments(this.upd.segments),
+        };
+    }
+    restoreState(saved) {
+        const bpd = readOptionalString(saved, 'bpd');
+        const upd = readOptionalString(saved, 'upd');
+        const restoredSystemId = readOptionalString(saved, 'systemId');
+        const restoredBpd = bpd === undefined ? undefined : Bpd3.fromSegments(decodeSegments(bpd), this.config.bankCode);
+        const restoredUpd = upd === undefined
+            ? undefined
+            : Upd3.fromSegments(decodeSegments(upd), this.config.bankCode, this.config.countryCode);
+        this.systemId = restoredSystemId;
+        this.bpd = restoredBpd;
+        this.upd = restoredUpd;
+    }
+    close() {
+        this.connection.close();
+    }
+}
+//# sourceMappingURL=protocol.js.map

package/dist/v3/protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../src/v3/protocol.ts"],"names":[],"mappings":"AAAA,uHAAuH;AAKvH,OAAO,EAAE,UAAU,EAAoB,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAGhD,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrF,OAAO,EACL,YAAY,EACZ,kBAAkB,EAClB,kBAAkB,GAInB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAmB,MAAM,iBAAiB,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAwC,MAAM,aAAa,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChG,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,iBAAiB,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzG,OAAO,EAAE,QAAQ,EAAkC,MAAM,aAAa,CAAC;AAEvE,oEAAoE;AACpE,MAAM,mBAAmB,GAAG,YAAY,CAAC;AAEzC,+EAA+E;AAC/E,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,uBAAuB,GAAG,CAAC,CAAC;AAKlC,SAAS,aAAa,CAAC,IAAY,EAAE,IAAY;IAC/C,0DAA0D;IAC1D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,MAAM,eAAe,CAAC,GAAG,IAAI,8DAA8D,CAAC,CAAC;IAClH,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAY,EAAE,SAAiB,EAAE,IAAY;IACrE,IAAI,IAAI,CAAC,MAAM,GAAG,SAAS;QAAE,MAAM,eAAe,CAAC,WAAW,SAAS,0BAA0B,EAAE,IAAI,CAAC,CAAC;AAC3G,CAAC;AAED,SAAS,eAAe,CAAC,MAAmB;IAC1C,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACvC,aAAa,CAAC,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;IAC/C,aAAa,CAAC,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IAC7C,aAAa,CAAC,MAAM,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;IACvD,8DAA8D;IAC9D,gBAAgB,CAAC,MAAM,CAAC,SAAS,EAAE,kBAAkB,EAAE,WAAW,CAAC,CAAC;IACpE,gBAAgB,CAAC,MAAM,CAAC,cAAc,EAAE,uBAAuB,EAAE,gBAAgB,CAAC,CAAC;IACnF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,6CAA6C;AAC7C,SAAS,GAAG,CAAC,KAAkC,EAAE,IAAY;IAC3D,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,4FAA4F;AAC5F,MAAM,OAAO,cAAc;IAChB,MAAM,CAAc;IACZ,GAAG,CAAS;IACZ,UAAU,CAAiB;IACnC,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;IAEvC,mEAAmE;IACnE,QAAQ,CAAqB;IACrB,GAAG,CAAmB;IACtB,GAAG,CAAmB;IAE9B;;;OAGG;IACH,YAAY,MAAmB,EAAE,GAAW,EAAE,SAA0B,EAAE,MAAsB;QAC9F,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,GAAG,GAAG,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,IAAI,cAAc,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED,2DAA2D;IAC3D,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC;IAC3D,CAAC;IAED,cAAc;QACZ,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,OAAO,GAAG,CAAC;IACb,CAAC;IAED,YAAY,CAAC,QAAgB,EAAE,SAAS,GAAG,KAAK;QAC9C,OAAO;YACL,QAAQ,CAAC,cAAc,CAAC;gBACtB,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW;gBACpC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;gBAC9B,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU;gBACpE,QAAQ;gBACR,gBAAgB,EAAE,CAAC,SAAS;aAC7B,CAAC;YACF,QAAQ,CAAC,qBAAqB,CAAC;gBAC7B,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,IAAI,CAAC;gBAClC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,IAAI,CAAC,CAAC;gBACpD,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,cAAc,IAAI,CAAC;gBACvC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS;gBAChC,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,cAAc;aAC3C,CAAC;SACH,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAMV;QACC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAChC,IAAI,OAAO,KAAK,SAAS;YAAE,kBAAkB,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QACnF,MAAM,QAAQ,GAAG,YAAY,CAAC;YAC5B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,aAAa,EAAE,OAAO,CAAC,MAAM;YAC7B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,QAAQ,EACN,OAAO,KAAK,SAAS;gBACnB,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC;oBACE,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW;oBACpC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;oBAC9B,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;oBAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,GAAG,EAAE,IAAI,CAAC,GAAG;oBACb,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;iBAC3C;YACP,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB,CAAC,CAAC;QACH,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC3E,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,KAAK,GAAG,eAAe,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;QACzG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,iBAAiB,CAAC,QAA0B;QAC1C,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAClC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC;QAC3G,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC;IACnE,CAAC;IAEO,kBAAkB,CAAC,QAA0B;QACnD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC;IACpF,CAAC;IAED,gGAAgG;IAChG,KAAK,CAAC,8BAA8B;QAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gCAAgC,EAAE,CAAC;QAC/D,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAClC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,gCAAgC;QAC5C,IAAI,SAA2B,CAAC;QAChC,IAAI,CAAC;YACH,SAAS,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,mBAAmB,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS;gBAAE,MAAM,KAAK,CAAC;YACxF,IAAI,CAAC,CAAC,KAAK,YAAY,UAAU,CAAC;gBAAE,MAAM,KAAK,CAAC;YAChD,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QAC9F,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,WAAoB;QAChD,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC;YACH,OAAO,MAAM,MAAM,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;QACzD,CAAC;gBAAS,CAAC;YACT,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC;QACrB,CAAC;IACH,CAAC;IAED,SAAS,CAAC,MAAiB,EAAE,SAAkB;QAC7C,OAAO,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,CAAC,KAAuB,EAAE,MAAwB;QACvD,OAAO,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;IAED,gCAAgC;IAExB,OAAO,CACb,WAAmB,EACnB,WAA8B,EAC9B,UAA0D,EAAE;QAE5D,OAAO,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,GAAG,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED,QAAQ;QACN,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC9C,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QAC5C,OAAO;YACL,KAAK,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;YACvC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;SAC5D,CAAC;IACJ,CAAC;IAED,YAAY;QACV,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1E,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QAC5C,OAAO;YACL,KAAK,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC;YACrE,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CACd,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;SAC1G,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,OAAgB;QACtB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC9D,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,IAAI,qBAAqB,CAAC,sDAAsD,CAAC,CAAC;QAC1F,CAAC;QACD,OAAO,YAAY,CAAyC,OAAO,EAAE;YACnE,KAAK,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,CAAC;YACzE,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC;YACvC,SAAS,EAAE,cAAc;YACzB,IAAI,EAAE,YAAY;SACnB,CAAC,CAAC;IACL,CAAC;IAED,YAAY,CACV,OAAgB,EAChB,MAAyB,EACzB,IAAsB,EACtB,EAAoB;QAEpB,MAAM,OAAO,GAAG,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;YAC5D,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE;YACzE,WAAW,EAAE,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW;YACxD,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE;SAC9E,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAChC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO;gBACL,KAAK,EAAE,CAAC,YAAY,EAAE,EAAE,CACtB,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC;gBAC9F,0FAA0F;gBAC1F,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CACd,gBAAgB,CACd,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAChC,CAAC;qBACE,KAAK,CAAC,CAAC,CAAC;qBACR,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;qBACzB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CACvB,EACD,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC;qBAChB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;qBACvB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAClC;aACJ,CAAC;QACJ,CAAC;QACD,OAAO;YACL,KAAK,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC;YACjG,gFAAgF;YAChF,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CACd,iBAAiB,CACf,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC;iBAChB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;iBACvB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,EACjC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC;iBAChB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;iBACvB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,EACjC,OAAO,CAAC,QAAQ,CACjB;SACJ,CAAC;IACJ,CAAC;IAED,sBAAsB;IAEtB,SAAS;QACP,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,IAAI;YAC/B,GAAG,EAAE,IAAI,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;YACtE,GAAG,EAAE,IAAI,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;SACvE,CAAC;IACJ,CAAC;IAED,YAAY,CAAC,KAAiB;QAC5B,MAAM,GAAG,GAAG,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC7C,MAAM,GAAG,GAAG,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC7C,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC/D,MAAM,WAAW,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjH,MAAM,WAAW,GACf,GAAG,KAAK,SAAS;YACf,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC5F,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC;QACjC,IAAI,CAAC,GAAG,GAAG,WAAW,CAAC;QACvB,IAAI,CAAC,GAAG,GAAG,WAAW,CAAC;IACzB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;CACF"}

package/dist/v3/segments.d.ts

@@ -0,0 +1,89 @@
+import { Account } from '../core/account.js';
+import { Balance } from '../core/balance.js';
+import { TanMedium } from '../tan/tan-models.js';
+import { type Segment, SegmentSpec, type SegmentValue } from './syntax.js';
+/** Bank identification (KIK): country code and bank code. */
+export declare function bankIdentification(countryCode: string, bankCode: string): SegmentValue;
+/** National account (KTV): account number, sub-account and bank identification. */
+export declare function nationalAccount(a: Account): SegmentValue[];
+/** International account (KTI): IBAN, BIC, then the national account. */
+export declare function internationalAccount(a: Account): SegmentValue[];
+/** Builders for the request segments the client sends. */
+export declare const Segments: Readonly<{
+    /** HKIDN: who is logging in, from which customer system. */
+    identification(parts: {
+        countryCode: string;
+        bankCode: string;
+        customerId: string;
+        systemId: string;
+        systemIdRequired: boolean;
+    }): SegmentSpec;
+    /** HKVVB: the parameter data versions the client knows, the dialog language and the registered product. */
+    processingPreparation(parts: {
+        bpdVersion: number;
+        updVersion: number;
+        language: number;
+        productId: string;
+        productVersion: string;
+    }): SegmentSpec;
+    /** HKSYN: requests a new customer system ID. */
+    synchronization(): SegmentSpec;
+    dialogEnd(dialogId: string): SegmentSpec;
+    /** HKTAN process 4: asks for strong customer authentication of the `segmentType` sent in the same message. */
+    tanProcess4(version: number, segmentType: string, mediumName?: string): SegmentSpec;
+    /** HKTAN process 2: submits the TAN (carried in the signature) for the order with `reference`. */
+    tanProcess2(version: number, reference: string): SegmentSpec;
+    /** HKTAN process S: asks whether the order with `reference` was approved in the banking app. */
+    tanProcessStatus(version: number, reference: string): SegmentSpec;
+    /** HKSAL: the balance of one account (not of all accounts). */
+    balance(version: number, account: Account, continuation?: string): SegmentSpec;
+    /** HKKAZ: MT940 transactions of one account. */
+    transactionsMt940(version: number, account: Account, period: {
+        from?: Date | undefined;
+        to?: Date | undefined;
+        continuation?: string | undefined;
+    }): SegmentSpec;
+    /** HKCAZ: camt transactions of one account in one of `formats`. */
+    transactionsCamt(version: number, account: Account, formats: readonly string[], period: {
+        from?: Date | undefined;
+        to?: Date | undefined;
+        continuation?: string | undefined;
+    }): SegmentSpec;
+    /** HKSPA: IBAN and BIC of all accounts. */
+    sepaAccounts(version: number, continuation?: string): SegmentSpec;
+    /** HKTAB: all TAN media of all classes. */
+    tanMedia(version: number): SegmentSpec;
+}>;
+/** The TAN part of a response (HITAN). */
+export declare class TanResponse {
+    /** The TAN process the segment answers: `4` asks for an approval, `S` answers a status request. */
+    readonly process: string | undefined;
+    readonly reference: string | undefined;
+    readonly challenge: string | undefined;
+    readonly hhdUc: Uint8Array | undefined;
+    readonly validUntil: Date | undefined;
+    readonly mediumName: string | undefined;
+    constructor(
+    /** The TAN process the segment answers: `4` asks for an approval, `S` answers a status request. */
+    process: string | undefined, reference: string | undefined, challenge: string | undefined, hhdUc: Uint8Array | undefined, validUntil: Date | undefined, mediumName: string | undefined);
+    static parse(s: Segment): TanResponse;
+    /** Whether the bank needs no approval although it answered with a TAN segment. */
+    get isDummy(): boolean;
+}
+/**
+ * Parses a balance (HISAL); throws `FormatError` if the booked balance is missing or malformed, or a balance has no
+ * credit/debit mark.
+ */
+export declare function parseBalance(s: Segment, account: Account): Balance;
+/**
+ * The account a balance (HISAL) belongs to: international (IBAN, BIC, then national) from version 7, national before.
+ */
+export declare function balanceAccount(s: Segment): Account;
+/**
+ * Parses the SEPA account list (HISPA), one account per data element. An account the bank marks as no payment account
+ * ("Kontoverwendung SEPA" N) is left out: it has no SEPA connection.
+ */
+export declare function parseSepaAccounts(s: Segment, defaultCountry: string, defaultBank: string): Account[];
+/** Parses the TAN media list (HITAB versions 4 and 5, PIN/TAN "TAN-Medium-Liste"). */
+export declare function parseTanMedia(s: Segment): TanMedium[];
+//# sourceMappingURL=segments.d.ts.map

package/dist/v3/segments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"segments.d.ts","sourceRoot":"","sources":["../../src/v3/segments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAqB,MAAM,sBAAsB,CAAC;AAGpE,OAAO,EAAE,KAAK,OAAO,EAAE,WAAW,EAAE,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3E,6DAA6D;AAC7D,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,YAAY,CAEtF;AAED,mFAAmF;AACnF,wBAAgB,eAAe,CAAC,CAAC,EAAE,OAAO,GAAG,YAAY,EAAE,CAE1D;AAED,yEAAyE;AACzE,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,OAAO,GAAG,YAAY,EAAE,CAE/D;AAWD,0DAA0D;AAC1D,eAAO,MAAM,QAAQ;IACnB,4DAA4D;0BACtC;QACpB,WAAW,EAAE,MAAM,CAAC;QACpB,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,GAAG,WAAW;IASf,2GAA2G;iCAC9E;QAC3B,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,WAAW;IAUf,gDAAgD;uBAC7B,WAAW;wBAIV,MAAM,GAAG,WAAW;IAIxC,8GAA8G;yBACzF,MAAM,eAAe,MAAM,eAAe,MAAM,GAAG,WAAW;IAInF,kGAAkG;yBAC7E,MAAM,aAAa,MAAM,GAAG,WAAW;IAI5D,gGAAgG;8BACtE,MAAM,aAAa,MAAM,GAAG,WAAW;IAIjE,+DAA+D;qBAC9C,MAAM,WAAW,OAAO,iBAAiB,MAAM,GAAG,WAAW;IAS9E,gDAAgD;+BAErC,MAAM,WACN,OAAO,UACR;QAAE,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;QAAC,EAAE,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,GAC5F,WAAW;IAWd,mEAAmE;8BAExD,MAAM,WACN,OAAO,WACP,SAAS,MAAM,EAAE,UAClB;QAAE,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;QAAC,EAAE,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,GAC5F,WAAW;IAYd,2CAA2C;0BACrB,MAAM,iBAAiB,MAAM,GAAG,WAAW;IAIjE,2CAA2C;sBACzB,MAAM,GAAG,WAAW;EAGtC,CAAC;AAKH,0CAA0C;AAC1C,qBAAa,WAAW;IAEpB,mGAAmG;IACnG,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS;IACpC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS;IACtC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS;IACtC,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS;IACtC,QAAQ,CAAC,UAAU,EAAE,IAAI,GAAG,SAAS;IACrC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS;;IANvC,mGAAmG;IAC1F,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,SAAS,EAAE,MAAM,GAAG,SAAS,EAC7B,SAAS,EAAE,MAAM,GAAG,SAAS,EAC7B,KAAK,EAAE,UAAU,GAAG,SAAS,EAC7B,UAAU,EAAE,IAAI,GAAG,SAAS,EAC5B,UAAU,EAAE,MAAM,GAAG,SAAS;IAGzC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,GAAG,WAAW;IAWrC,kFAAkF;IAClF,IAAI,OAAO,IAAI,OAAO,CAErB;CACF;AA0BD;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CA6BlE;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO,CAYlD;AAaD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,EAAE,CAiBpG;AAQD,sFAAsF;AACtF,wBAAgB,aAAa,CAAC,CAAC,EAAE,OAAO,GAAG,SAAS,EAAE,CAgCrD"}

package/dist/v3/segments.js

@@ -0,0 +1,283 @@
+// Internal to the package, and named after the FinTS specification. Documentation is where the meaning is not evident.
+import { Account } from '../core/account.js';
+import { Amount, withMark } from '../core/amount.js';
+import { Balance } from '../core/balance.js';
+import { noReference } from '../session/protocol.js';
+import { TanMedium, tanMediumStatusOf } from '../tan/tan-models.js';
+import { formatFintsDate, parseFintsDate, parseFintsDateTime } from '../util/dates.js';
+import { FormatError } from '../util/errors.js';
+import { SegmentSpec } from './syntax.js';
+/** Bank identification (KIK): country code and bank code. */
+export function bankIdentification(countryCode, bankCode) {
+    return [countryCode, bankCode];
+}
+/** National account (KTV): account number, sub-account and bank identification. */
+export function nationalAccount(a) {
+    return [a.accountNumber, a.subAccount, a.countryCode, a.bankCode];
+}
+/** International account (KTI): IBAN, BIC, then the national account. */
+export function internationalAccount(a) {
+    return [a.iban, a.bic, ...nationalAccount(a)];
+}
+function dateOrEmpty(date) {
+    return date === undefined ? undefined : formatFintsDate(date);
+}
+// HKTAN fields: order reference (Auftragsreferenz), "more TANs follow" and the TAN medium name.
+const orderReferenceField = 5;
+const moreTansField = 6;
+const tanMediumField = 11;
+/** Builders for the request segments the client sends. */
+export const Segments = Object.freeze({
+    /** HKIDN: who is logging in, from which customer system. */
+    identification(parts) {
+        return new SegmentSpec('HKIDN', 2, [
+            bankIdentification(parts.countryCode, parts.bankCode),
+            parts.customerId,
+            parts.systemId,
+            parts.systemIdRequired ? 1 : 0,
+        ]);
+    },
+    /** HKVVB: the parameter data versions the client knows, the dialog language and the registered product. */
+    processingPreparation(parts) {
+        return new SegmentSpec('HKVVB', 3, [
+            parts.bpdVersion,
+            parts.updVersion,
+            parts.language,
+            parts.productId,
+            parts.productVersion,
+        ]);
+    },
+    /** HKSYN: requests a new customer system ID. */
+    synchronization() {
+        return new SegmentSpec('HKSYN', 3, [0]);
+    },
+    dialogEnd(dialogId) {
+        return new SegmentSpec('HKEND', 1, [dialogId]);
+    },
+    /** HKTAN process 4: asks for strong customer authentication of the `segmentType` sent in the same message. */
+    tanProcess4(version, segmentType, mediumName) {
+        return SegmentSpec.numbered('HKTAN', version, { 1: '4', 2: segmentType, [tanMediumField]: mediumName });
+    },
+    /** HKTAN process 2: submits the TAN (carried in the signature) for the order with `reference`. */
+    tanProcess2(version, reference) {
+        return SegmentSpec.numbered('HKTAN', version, { 1: '2', [orderReferenceField]: reference, [moreTansField]: false });
+    },
+    /** HKTAN process S: asks whether the order with `reference` was approved in the banking app. */
+    tanProcessStatus(version, reference) {
+        return SegmentSpec.numbered('HKTAN', version, { 1: 'S', [orderReferenceField]: reference, [moreTansField]: false });
+    },
+    /** HKSAL: the balance of one account (not of all accounts). */
+    balance(version, account, continuation) {
+        return new SegmentSpec('HKSAL', version, [
+            version >= 7 ? internationalAccount(account) : nationalAccount(account),
+            false,
+            null,
+            continuation,
+        ]);
+    },
+    /** HKKAZ: MT940 transactions of one account. */
+    transactionsMt940(version, account, period) {
+        return new SegmentSpec('HKKAZ', version, [
+            version >= 7 ? internationalAccount(account) : nationalAccount(account),
+            false,
+            dateOrEmpty(period.from),
+            dateOrEmpty(period.to),
+            null,
+            period.continuation,
+        ]);
+    },
+    /** HKCAZ: camt transactions of one account in one of `formats`. */
+    transactionsCamt(version, account, formats, period) {
+        return new SegmentSpec('HKCAZ', version, [
+            internationalAccount(account),
+            formats,
+            false,
+            dateOrEmpty(period.from),
+            dateOrEmpty(period.to),
+            null,
+            period.continuation,
+        ]);
+    },
+    /** HKSPA: IBAN and BIC of all accounts. */
+    sepaAccounts(version, continuation) {
+        return new SegmentSpec('HKSPA', version, [null, ...(version >= 2 ? [null, continuation] : [])]);
+    },
+    /** HKTAB: all TAN media of all classes. */
+    tanMedia(version) {
+        return new SegmentSpec('HKTAB', version, [0, 'A']);
+    },
+});
+/** Positions of the data elements in the TAN part of a response (HITAN versions 6 and 7), after the segment header. */
+const Hitan = { process: 1, reference: 3, challenge: 4, hhdUc: 5, validUntil: 6, mediumName: 7 };
+/** The TAN part of a response (HITAN). */
+export class TanResponse {
+    process;
+    reference;
+    challenge;
+    hhdUc;
+    validUntil;
+    mediumName;
+    constructor(
+    /** The TAN process the segment answers: `4` asks for an approval, `S` answers a status request. */
+    process, reference, challenge, hhdUc, validUntil, mediumName) {
+        this.process = process;
+        this.reference = reference;
+        this.challenge = challenge;
+        this.hhdUc = hhdUc;
+        this.validUntil = validUntil;
+        this.mediumName = mediumName;
+    }
+    static parse(s) {
+        return new TanResponse(s.text(Hitan.process), s.text(Hitan.reference), s.text(Hitan.challenge), s.binary(Hitan.hhdUc), parseFintsDateTime(s.text(Hitan.validUntil, 0), s.text(Hitan.validUntil, 1)), s.text(Hitan.mediumName));
+    }
+    /** Whether the bank needs no approval although it answered with a TAN segment. */
+    get isDummy() {
+        return this.reference === undefined || this.reference === noReference;
+    }
+}
+/** Positions of the data elements in a balance (HISAL), after the segment header. */
+const Hisal = {
+    account: 1,
+    productName: 2,
+    accountCurrency: 3,
+    bookedBalance: 4,
+    pendingBalance: 5,
+    creditLine: 6,
+    availableAmount: 7,
+    usedAmount: 8,
+    overdraft: 9,
+    bookingTime: 10,
+};
+/** Positions inside a balance (SDO): credit/debit mark, value, currency, date and time. */
+const Sdo = { mark: 0, value: 1, currency: 2, date: 3, time: 4 };
+/** An amount with currency (BTG) at `index`, or `undefined` if empty. */
+function amountAt(s, index, fallbackCurrency) {
+    const value = s.text(index, 0);
+    if (value === undefined)
+        return undefined;
+    return Amount.parseDecimal(value, s.text(index, 1) ?? fallbackCurrency);
+}
+/**
+ * Parses a balance (HISAL); throws `FormatError` if the booked balance is missing or malformed, or a balance has no
+ * credit/debit mark.
+ */
+export function parseBalance(s, account) {
+    const currency = s.text(Hisal.accountCurrency) ?? account.currency;
+    const signedBalance = (index) => {
+        const value = s.text(index, Sdo.value);
+        if (value === undefined)
+            return undefined;
+        const amountCurrency = s.text(index, Sdo.currency) ?? currency;
+        if (amountCurrency === undefined)
+            throw new FormatError('Balance without currency');
+        return withMark(Amount.parseDecimal(value, amountCurrency), s.text(index, Sdo.mark), 'C', 'D');
+    };
+    const booked = signedBalance(Hisal.bookedBalance);
+    if (booked === undefined)
+        throw new FormatError('Balance without booked amount');
+    const bookedDate = s.text(Hisal.bookedBalance, Sdo.date);
+    const bookedAsOf = parseFintsDate(bookedDate);
+    if (bookedAsOf === undefined)
+        throw new FormatError('Balance without date');
+    return new Balance({
+        account,
+        productName: s.text(Hisal.productName),
+        booked,
+        bookedAsOf,
+        bookedAsOfTime: parseFintsDateTime(bookedDate, s.text(Hisal.bookedBalance, Sdo.time)),
+        pending: signedBalance(Hisal.pendingBalance),
+        creditLine: amountAt(s, Hisal.creditLine, booked.currency),
+        available: amountAt(s, Hisal.availableAmount, booked.currency),
+        used: amountAt(s, Hisal.usedAmount, booked.currency),
+        overdraft: amountAt(s, Hisal.overdraft, booked.currency),
+        bookingDate: parseFintsDate(s.text(Hisal.bookingTime, 0)),
+        bookingTime: parseFintsDateTime(s.text(Hisal.bookingTime, 0), s.text(Hisal.bookingTime, 1)),
+    });
+}
+/**
+ * The account a balance (HISAL) belongs to: international (IBAN, BIC, then national) from version 7, national before.
+ */
+export function balanceAccount(s) {
+    const fields = s.texts(Hisal.account);
+    const international = s.version >= 7;
+    const national = international ? 2 : 0;
+    return new Account({
+        iban: international ? fields[0] : undefined,
+        bic: international ? fields[1] : undefined,
+        accountNumber: fields[national],
+        subAccount: fields[national + 1],
+        countryCode: fields[national + 2] ?? '',
+        bankCode: fields[national + 3] ?? '',
+    });
+}
+/** Positions inside an account of the SEPA account list (HISPA "Kontoverbindung SEPA"). */
+const Hispa = {
+    isSepaAccount: 0,
+    iban: 1,
+    bic: 2,
+    accountNumber: 3,
+    subAccount: 4,
+    countryCode: 5,
+    bankCode: 6,
+};
+/**
+ * Parses the SEPA account list (HISPA), one account per data element. An account the bank marks as no payment account
+ * ("Kontoverwendung SEPA" N) is left out: it has no SEPA connection.
+ */
+export function parseSepaAccounts(s, defaultCountry, defaultBank) {
+    const accounts = [];
+    for (let i = 1; i < s.length; i++) {
+        if (s.text(i, Hispa.isSepaAccount) === 'N')
+            continue;
+        if (s.text(i, Hispa.iban) === undefined && s.text(i, Hispa.accountNumber) === undefined)
+            continue;
+        accounts.push(new Account({
+            iban: s.text(i, Hispa.iban),
+            bic: s.text(i, Hispa.bic),
+            accountNumber: s.text(i, Hispa.accountNumber),
+            subAccount: s.text(i, Hispa.subAccount),
+            countryCode: s.text(i, Hispa.countryCode) ?? defaultCountry,
+            bankCode: s.text(i, Hispa.bankCode) ?? defaultBank,
+        }));
+    }
+    return accounts;
+}
+/**
+ * Elements of the account a TAN medium belongs to, a national account (`ktv`: account number, sub-account, country
+ * code, bank code), which shifts every field behind it.
+ */
+const accountWidth = 4;
+/** Parses the TAN media list (HITAB versions 4 and 5, PIN/TAN "TAN-Medium-Liste"). */
+export function parseTanMedia(s) {
+    // Version 5 adds the security function in front of the card number.
+    const version5 = s.version >= 5;
+    const cardNumber = version5 ? 3 : 2;
+    // The card number, card sequence number and card type are followed by the account. Behind it come: valid from, valid
+    // until, TAN list number, name, masked and full mobile number, SMS charge account (six elements), number of free TANs,
+    // last use, activation.
+    const after = cardNumber + 3 + accountWidth;
+    const media = [];
+    // The first data element is the TAN usage option; the media follow.
+    for (let i = 2; i < s.length; i++) {
+        const fields = s.texts(i);
+        const mediumClass = fields[0];
+        if (mediumClass === undefined)
+            continue;
+        media.push(new TanMedium({
+            mediumClass,
+            status: tanMediumStatusOf(fields[1]),
+            securityFunction: version5 ? fields[2] : undefined,
+            cardNumber: fields[cardNumber],
+            cardSequenceNumber: fields[cardNumber + 1],
+            validFrom: parseFintsDate(fields[after]),
+            validUntil: parseFintsDate(fields[after + 1]),
+            name: fields[after + 3],
+            mobileNumberMasked: fields[after + 4],
+            mobileNumber: fields[after + 5],
+            lastUsed: parseFintsDate(fields[after + 13]),
+            activatedOn: parseFintsDate(fields[after + 14]),
+        }));
+    }
+    return media;
+}
+//# sourceMappingURL=segments.js.map