lib-fints 1.0.0

package/dist/tests/HITAB.test.js

@@ -0,0 +1,19 @@
+import { describe, it, expect } from 'vitest';
+import { registerSegments } from '../segments/registry.js';
+import { HITAB } from '../segments/HITAB.js';
+import { decode, encode } from '../segment.js';
+registerSegments();
+describe('HITAB', () => {
+    it('decodes correctly', () => {
+        const text = "HITAB:5:4:3+0+A:1:::::::::::Media1::::::::+A:1:::::::::::Media2::::::::'";
+        const segment = decode(text);
+        expect(segment.mediaList.length).toBe(2);
+        expect(segment.mediaList[0].name).toBe('Media1');
+    });
+    it('decode and encode roundtrip matches', () => {
+        HITAB.Id;
+        const text = "HITAB:5:4:3+0+A:1:::::::::::Greenwood::::::::+A:1:::::::::::iPhone::::::::'";
+        const segment = decode(text);
+        expect(encode(segment)).toBe(text);
+    });
+});

package/dist/tests/HITANS.test.js

@@ -0,0 +1,19 @@
+import { describe, it, expect } from 'vitest';
+import { registerSegments } from '../segments/registry.js';
+import { decode, encode } from '../segment.js';
+registerSegments();
+describe('HITANS', () => {
+    it('decode and encode roundtrip matches', () => {
+        const text = "HITANS:163:6:4+1+1+1+J:N:0:910:2:HHD1.3.0:::chipTAN manuell:6:1:TAN-Nummer:3:J:2:N:0:0:N:N:00:0:N:1:911:2:HHD1.3.2OPT:HHDOPT1:1.3.2:chipTAN optisch:6:1:TAN-Nummer:3:J:2:N:0:0:N:N:00:0:N:1:912:2:HHD1.3.2USB:HHDUSB1:1.3.2:chipTAN-USB:6:1:TAN-Nummer:3:J:2:N:0:0:N:N:00:0:N:1:913:2:Q1S:Secoder_UC:1.2.0:chipTAN-QR:6:1:TAN-Nummer:3:J:2:N:0:0:N:N:00:0:N:1:920:2:smsTAN:::smsTAN:6:1:TAN-Nummer:3:J:2:N:0:0:N:N:00:2:N:5:921:2:TAN2go:::TAN2go:6:1:TAN-Nummer:3:J:2:N:0:0:N:N:00:2:N:2:900:2:iTAN:::iTAN:6:1:TAN-Nummer:3:J:2:N:0:0:N:N:00:0:N:0'";
+        const segment = decode(text);
+        expect(segment.params.oneStepAllowed).toBe(true);
+        expect(segment.params.tanMethods[0].methodName).toBe('chipTAN manuell');
+        expect(encode(segment)).toBe(text);
+    });
+    it('decodes v1', () => {
+        const text = 'HITANS:163:1:4+1+1+0+J:N:0:0:900:2:iTAN:iTAN:6:1:Index:3:1:N:N';
+        const segment = decode(text);
+        expect(segment.params.tanMethods[0].methodId).toBe('iTAN');
+        expect(segment.params.tanMethods[0].methodName).toBe('iTAN');
+    });
+});

package/dist/tests/HIUPA.test.js

@@ -0,0 +1,11 @@
+import { describe, it, expect } from 'vitest';
+import { registerSegments } from '../segments/registry.js';
+import { decode, encode } from '../segment.js';
+registerSegments();
+describe('HIUPA', () => {
+    it('decode and encode roundtrip matches', () => {
+        const text = "HIUPA:165:4:4+1197651234+0+0++PERSNR0010488691234'";
+        const segment = decode(text);
+        expect(encode(segment)).toBe(text);
+    });
+});

package/dist/tests/HIUPD.test.js

@@ -0,0 +1,11 @@
+import { describe, it, expect } from 'vitest';
+import { registerSegments } from '../segments/registry.js';
+import { decode, encode } from '../segment.js';
+registerSegments();
+describe('HIUPD', () => {
+    it('decode and encode roundtrip matches', () => {
+        const text = `HIUPD:167:6:4+1234567890::280:12030000+DE19120300001234567890+1197651234+1+EUR+KONTO INHABER 1+KONTO INHABER 2+Sichteinlagen++HKSAK:1+HKISA:1+HKSSP:1+HKPAE:1+HKTAB:1+HKTAZ:1+HKTML:1+HKSPA:1+HKCAZ:1+HKCCM:1+HKCCS:1+HKCDB:1+HKCDE:1+HKCDL:1+HKCDN:1+HKCDU:1+HKCMB:1+HKCME:1+HKCML:1+HKCSA:1+HKCSB:1+HKCSE:1+HKCSL:1+HKDSB:1+HKDSW:1+HKEKA:1+DKPSA:1+DKPSP:1+HKTAN:1+DKANA:1+DKANL:1+DKKBA:1+DKSID:1+DKBAZ:1+DKZDF:1+DKZDL:1+HKFRD:1+HKAUB:1+HKKAZ:1+HKKIF:1+HKSAL:1+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++{"umsltzt"?:"2024-01-20-14.50.31.849705"}'`;
+        const segment = decode(text);
+        expect(encode(segment)).toBe(text);
+    });
+});

package/dist/tests/HKIDN.test.js

@@ -0,0 +1,22 @@
+import { describe, it, expect } from 'vitest';
+import { HKIDN } from '../segments/HKIDN.js';
+import { registerSegments } from '../segments/registry.js';
+import { decode, encode } from '../segment.js';
+registerSegments();
+describe('HKIDN', () => {
+    it('encodes correctly', () => {
+        const segment = {
+            header: { segId: HKIDN.Id, segNr: 1, version: 2 },
+            bank: { country: 280, bankId: '12030000' },
+            systemId: '4711',
+            customerId: '1022334455_p',
+            systemIdRequired: 1,
+        };
+        expect(encode(segment)).toBe("HKIDN:1:2+280:12030000+1022334455_p+4711+1'");
+    });
+    it('decode and encode roundtrip matches', () => {
+        const text = "HKIDN:1:2+280:12030000+1022334455_p+4711+1'";
+        const segment = decode(text);
+        expect(encode(segment)).toBe(text);
+    });
+});

package/dist/tests/HKSAL.test.js

@@ -0,0 +1,45 @@
+import { describe, it, expect } from 'vitest';
+import { registerSegments } from '../segments/registry.js';
+import { HKSAL } from '../segments/HKSAL.js';
+import { decode, encode } from '../segment.js';
+registerSegments();
+describe('HKSAL v8', () => {
+    it('encode', () => {
+        const segment = {
+            header: { segId: HKSAL.Id, segNr: 1, version: 8 },
+            allAccounts: false,
+            account: {
+                iban: 'DE991234567123456',
+                bic: 'BANK12',
+                accountNumber: '123456',
+                bank: { country: 280, bankId: '12030000' },
+            },
+        };
+        expect(encode(segment)).toBe("HKSAL:1:8+DE991234567123456:BANK12:123456::280:12030000+N'");
+    });
+    it('decode and encode roundtrip matches', () => {
+        const text = "HKSAL:0:8+DE991234567123456:BANK12+N'";
+        const segment = decode(text);
+        expect(encode(segment)).toBe(text);
+    });
+});
+describe('HKSAL v6', () => {
+    it('encode', () => {
+        const segment = {
+            header: { segId: HKSAL.Id, segNr: 1, version: 6 },
+            allAccounts: false,
+            account: {
+                iban: 'DE991234567123456',
+                bic: 'BANK12',
+                accountNumber: '123456',
+                bank: { country: 280, bankId: '12030000' },
+            },
+        };
+        expect(encode(segment)).toBe("HKSAL:1:6+123456::280:12030000+N'");
+    });
+    it('decode and encode roundtrip matches', () => {
+        const text = "HKSAL:0:6+123456::280:12030000+N'";
+        const segment = decode(text);
+        expect(encode(segment)).toBe(text);
+    });
+});

package/dist/tests/HKTAN.test.js

@@ -0,0 +1,21 @@
+import { describe, it, expect } from 'vitest';
+import { registerSegments } from '../segments/registry.js';
+import { HKTAN } from '../segments/HKTAN.js';
+import { decode, encode } from '../segment.js';
+registerSegments();
+describe('HKTAN', () => {
+    it('encode', () => {
+        const segment = {
+            header: { segId: HKTAN.Id, segNr: 1, version: 6 },
+            segId: 'HKKAZ',
+            tanProcess: 4,
+            tanMedia: 'Media1',
+        };
+        expect(encode(segment)).toBe("HKTAN:1:6+4+HKKAZ+++++++++Media1'");
+    });
+    it('decode and encode roundtrip matches', () => {
+        const text = "HKTAN:5:6+4+HKIDN'";
+        const segment = decode(text);
+        expect(encode(segment)).toBe(text);
+    });
+});

package/dist/tests/HNSHK.test.js

@@ -0,0 +1,11 @@
+import { describe, it, expect } from 'vitest';
+import { registerSegments } from '../segments/registry.js';
+import { decode, encode } from '../segment.js';
+registerSegments();
+describe('HNSHK', () => {
+    it('decode and encode roundtrip matches', () => {
+        const text = "HNSHK:2:4+PIN:1+999+6506545+1+1+1::0+1+1:20240121:120140+1:999:1+6:10:16+280:12030000:1234567890_p:S:0:0'";
+        const segment = decode(text);
+        expect(encode(segment)).toBe(text);
+    });
+});

package/dist/tests/HNVSK.test.js

@@ -0,0 +1,11 @@
+import { describe, it, expect } from 'vitest';
+import { registerSegments } from '../segments/registry.js';
+import { decode, encode } from '../segment.js';
+registerSegments();
+describe('HNVSK', () => {
+    it('decode and encode roundtrip matches', () => {
+        const text = "HNVSK:998:3+PIN:1+998+1+1::0+1:20240121:120140+2:2:13:@8@00000000:5:1+280:12030000:1234567890_p:S:0:0+0'";
+        const segment = decode(text);
+        expect(encode(segment)).toBe(text);
+    });
+});

package/dist/tests/client.test.js

@@ -0,0 +1,33 @@
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { FinTSClient } from '../client.js';
+import { Dialog } from '../dialog.js';
+import { FinTSConfig } from '../config.js';
+describe('FinTSClient', () => {
+    let dialogInitializeMock;
+    let dialogEndMock;
+    beforeEach(() => {
+        dialogInitializeMock = vi.spyOn(Dialog.prototype, 'initialize');
+        dialogEndMock = vi.spyOn(Dialog.prototype, 'end');
+    });
+    afterEach(() => {
+        dialogInitializeMock.mockRestore();
+        dialogEndMock.mockRestore();
+    });
+    it('sends a message', async () => {
+        const client = new FinTSClient(FinTSConfig.forFirstTimeUse('product', '1.0', 'http://localhost', '12030000', 'user'));
+        dialogInitializeMock.mockResolvedValueOnce({
+            dialogId: 'DIALOG1',
+            success: true,
+            requiresTan: false,
+            bankingInformationUpdated: true,
+            bankingInformation: { systemId: 'SYSTEM01', bankMessages: [] },
+            bankAnswers: [{ code: 20, text: 'Auftrag ausgeführt' }],
+        });
+        const response = await client.synchronize();
+        expect(response.success).toBe(true);
+        expect(response.requiresTan).toBe(false);
+        expect(response.bankingInformation).toBeDefined();
+        expect(dialogInitializeMock).toHaveBeenCalledOnce();
+        expect(dialogEndMock).toHaveBeenCalledOnce();
+    });
+});

package/dist/tests/datatypes.test.js

@@ -0,0 +1,8 @@
+import { describe, it, expect } from 'vitest';
+import { BankIdentification } from '../dataGroups/BankIdentification.js';
+describe('BankIdentification', () => {
+    it('encodes correctly', () => {
+        const id = new BankIdentification('bank', 1, 1);
+        expect(id.encode({ country: 280, bankId: '12030000' }, [], 1)).toBe('280:12030000');
+    });
+});

package/dist/tests/message.test.js

@@ -0,0 +1,80 @@
+import { describe, expect, it } from 'vitest';
+import { CustomerMessage, Message } from '../message.js';
+import { HKIDN } from '../segments/HKIDN.js';
+import { HKVVB } from '../segments/HKVVB.js';
+import { Language } from '../codes.js';
+import { registerSegments } from '../segments/registry.js';
+import { HIRMS } from '../segments/HIRMS.js';
+import { HIRMG } from '../segments/HIRMG.js';
+registerSegments();
+describe('Message', () => {
+    describe('decoding', () => {
+        it('with known segments', () => {
+            const message = Message.decode("HNHBK:1:3+000000000108+300+0+1'HKIDN:2:2+280:12030000+9999999999+0+0'HKVVB:3:3+0+0+0+ABCDEF+1.0'HNHBS:4:1+1'");
+            expect(message.segments.length).toBe(4);
+        });
+        it('with one unknown segment', () => {
+            const message = Message.decode("HNHBK:1:3+000000000108+300+0+1'HKIDN:2:2+280:12030000+9999999999+0+0'HKVVB:3:3+0+0+0+ABCDEF+1.0'HIXXX:4:1+13'HNHBS:5:1+1'");
+            expect(message.segments.length).toBe(5);
+        });
+        it('with signed and encrypted data', () => {
+            const text = "HNHBK:1:3+000000000412+300+0+1'HNVSK:998:3+PIN:1+998+1+1+1:20240601:102151+2:2:13:@8@00000000:5:1+280:123456:user1:S:0:0+0'HNVSD:999:1+@259@HNSHK:2:4+PIN:2+944+1+1+1+1::rWkyTQV5yI8BAABFH0nthrBCCgQA+1+1:20240601:102151+1:3:1+6:10:16+280:30520037:user1:S:0:0'HKIDN:3:2+280:123456+user1+rWkyTQV5yI8BAABFH0nthrBCCgQA+1'HKVVB:4:3+43+9+0+9FA6681DEC0CF3046BFC2F8A6+0.1'HKTAN:5:6+4+HKIDN'HNSHA:6:2+1++12345''HNHBS:7:1+1'";
+            const message = Message.decode(text);
+            const hkidn = message.findSegment(HKIDN.Id);
+            expect(hkidn?.customerId).toBe('user1');
+            expect(hkidn?.bank.bankId).toBe('123456');
+        });
+    });
+    describe('findAllSegments()', () => {
+        it('returns all segments with given ID', () => {
+            const hirmg = {
+                header: { segId: HIRMG.Id, segNr: 1, version: HIRMG.Version },
+                answers: [{ code: 20, text: 'Message 1' }],
+            };
+            const hirms1 = {
+                header: { segId: HIRMS.Id, segNr: 2, version: HIRMS.Version },
+                answers: [{ code: 30, text: 'Message 2' }],
+            };
+            const hirms2 = {
+                header: { segId: HIRMS.Id, segNr: 3, version: HIRMS.Version },
+                answers: [{ code: 40, text: 'Message 3' }],
+            };
+            const message = new Message([hirmg, hirms1, hirms2]);
+            const segments = message.findAllSegments(HIRMS.Id);
+            expect(segments.length).toBe(2);
+            expect(segments.map((s) => s.header.segId)).toEqual([HIRMS.Id, HIRMS.Id]);
+        });
+    });
+});
+describe('CustomerMessage', () => {
+    const hkidn = {
+        header: { segId: HKIDN.Id, segNr: 0, version: HKIDN.Version },
+        bank: { country: 280, bankId: '12030000' },
+        customerId: '9999999999',
+        systemId: '0',
+        systemIdRequired: 0,
+    };
+    const hkvvb = {
+        header: { segId: HKVVB.Id, segNr: 0, version: HKVVB.Version },
+        bpdVersion: 0,
+        updVersion: 0,
+        dialogLanguage: Language.Default,
+        productId: 'ABCDEF',
+        productVersion: '1.0',
+    };
+    it('with no signature encodes correctly', () => {
+        const message = new CustomerMessage('0', 1);
+        message.addSegment(hkidn);
+        message.addSegment(hkvvb);
+        const encodedMessage = message.encode();
+        expect(encodedMessage).toBe("HNHBK:1:3+000000000108+300+0+1'HKIDN:2:2+280:12030000+9999999999+0+0'HKVVB:3:3+0+0+0+ABCDEF+1.0'HNHBS:4:1+1'");
+    });
+    it('with signature encodes correctly', () => {
+        const customerMessage = new CustomerMessage('0', 1);
+        customerMessage.addSegment(hkidn);
+        customerMessage.addSegment(hkvvb);
+        customerMessage.sign(280, '12030000', '12345678', '123', '0', 900, '12345');
+        const encodedMessage = customerMessage.encode();
+        const message = Message.decode(encodedMessage);
+    });
+});

package/dist/tests/mt940parser.test.js

@@ -0,0 +1,56 @@
+import { describe, expect, it } from 'vitest';
+import { Mt940Parser } from '../mt940parser.js';
+describe('parse', () => {
+    it('parses a MT940 input string', () => {
+        const input = ':20:1234567\r\n' +
+            ':21:9876543210\r\n' +
+            ':25:10020030/1234567\r\n' +
+            ':28C:5/1\r\n' +
+            ':60F:C021101EUR2187,95\r\n' +
+            ':61:0211011102DR800,NSTONONREF//55555\r\n' +
+            ':86:008?00DAUERAUFTRAG?100599?20Miete Nov\r\n' +
+            'ember?3010020030?31234567\r\n' +
+            '?32MUELLER?3433\r\n' +
+            '9\r\n' +
+            ':61:0211021102CR3000,NTRFNONREF//55555\r\n' +
+            'Additional Information\r\n' +
+            ':86:051?00UEBERWEISUNG?100599?20EREF+53XA\r\n' +
+            'QC7FDN1K2FO1\r\n' +
+            '?21SVWZ+Gehalt?22CRED+Arbeitgeber?3050060400?31084\r\n' +
+            '7564700?32MUELLER?34339\r\n' +
+            ':62F:C021131EUR4387,95\r\n';
+        const parser = new Mt940Parser(input);
+        const statements = parser.parse();
+        const statement = statements[0];
+        expect(statement.transactionReference).toBe('1234567');
+        expect(statement.relatedReference).toBe('9876543210');
+        expect(statement.account).toBe('10020030/1234567');
+        expect(statement.number).toBe('5/1');
+        expect(statement.openingBalance?.date).toEqual(new Date('2002-11-01T00:00'));
+        expect(statement.openingBalance?.currency).toBe('EUR');
+        expect(statement.openingBalance?.value).toBe(2187.95);
+        expect(statement.closingBalance?.date).toEqual(new Date('2002-11-31T00:00'));
+        expect(statement.closingBalance?.currency).toBe('EUR');
+        expect(statement.closingBalance?.value).toBe(4387.95);
+        expect(statement.transactions).toHaveLength(2);
+        expect(statement.transactions[0].valueDate).toEqual(new Date('2002-11-01T00:00'));
+        expect(statement.transactions[0].entryDate).toEqual(new Date('2002-11-02T00:00'));
+        expect(statement.transactions[0].fundsCode).toBe('R');
+        expect(statement.transactions[0].amount).toBe(-800);
+        expect(statement.transactions[0].transactionType).toBe('NSTO');
+        expect(statement.transactions[0].customerReference).toBe('NONREF');
+        expect(statement.transactions[0].bankReference).toBe('55555');
+        expect(statement.transactions[0].transactionCode).toBe('008');
+        expect(statement.transactions[0].bookingText).toBe('DAUERAUFTRAG');
+        expect(statement.transactions[0].primeNotesNr).toBe('0599');
+        expect(statement.transactions[0].purpose).toBe('Miete November');
+        expect(statement.transactions[0].remoteBankId).toBe('10020030');
+        expect(statement.transactions[0].remoteAccountNumber).toBe('234567');
+        expect(statement.transactions[0].remoteName).toBe('MUELLER');
+        expect(statement.transactions[0].textKeyExtension).toBe('339');
+        expect(statement.transactions[1].purpose).toBe('Gehalt');
+        expect(statement.transactions[1].e2eReference).toBe('53XAQC7FDN1K2FO1');
+        expect(statement.transactions[1].remoteIdentifier).toBe('Arbeitgeber');
+        expect(statement.transactions[1].additionalInformation).toBe('Additional Information');
+    });
+});

package/dist/tests/parser.test.js

@@ -0,0 +1,20 @@
+import { describe, expect, it } from 'vitest';
+import { splitBySeparator } from '../parser.js';
+describe('splitBySeparator', () => {
+    it('works with binary elements', () => {
+        const text = "HNVSD:999:1+@105@HNSHK:2:4+PIN:1+999+6506545+1+1+1::0+1+1:20240121:120140+1:999:1+6:10:16+280:12030000:1234567890_p:S:0:0''HNHBS:7:1+1'";
+        const segments = splitBySeparator(text, "'");
+        expect(segments.length).toBe(2);
+        expect(segments[0].slice(0, 5)).toBe('HNVSD');
+        expect(segments[1].slice(0, 5)).toBe('HNHBS');
+    });
+    it('ignores escaped separators', () => {
+        const text = 'HNSHK:2:4+PIN:1+999+hello?+world??+3+2+1';
+        const segments = splitBySeparator(text, '+');
+        expect(segments.length).toBe(7);
+        expect(segments[0]).toBe('HNSHK:2:4');
+        expect(segments[1]).toBe('PIN:1');
+        expect(segments[3]).toBe('hello?+world??');
+        expect(segments[6]).toBe('1');
+    });
+});

package/dist/types/accountBalance.d.ts

@@ -0,0 +1,9 @@
+export type AccountBalance = {
+    date: Date;
+    currency: string;
+    balance: number;
+    notedBalance?: number;
+    creditLimit?: number;
+    availableAmount?: number;
+};
+//# sourceMappingURL=accountBalance.d.ts.map

package/dist/types/accountBalance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accountBalance.d.ts","sourceRoot":"","sources":["../../src/accountBalance.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,IAAI,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC"}

package/dist/types/bankAccount.d.ts

@@ -0,0 +1,27 @@
+import { Account } from './dataGroups/Account.js';
+import { AccountLimit, AllowedTransactions } from './segments/HIUPD.js';
+export declare enum AccountType {
+    CheckingAccount = "CheckingAccount",
+    SavingsAccount = "SavingsAccount",
+    FixedDepositAccount = "FixedDepositAccount",
+    SecuritiesAccount = "SecuritiesAccount",
+    LoanMortgageAccount = "LoanMortgageAccount",
+    CreditCardAccount = "CreditCardAccount",
+    InvestmentCompanyFund = "InvestmentCompanyFund",
+    HomeSavingsContract = "HomeSavingsContract",
+    InsurancePolicy = "InsurancePolicy",
+    Miscellaneous = "Miscellaneous"
+}
+export type BankAccount = Account & {
+    iban?: string;
+    customerId: string;
+    accountType: AccountType;
+    currency: string;
+    holder1: string;
+    holder2?: string;
+    product?: string;
+    limit?: AccountLimit;
+    allowedTransactions?: AllowedTransactions[];
+};
+export declare function finTsAccountTypeToEnum(accountType: number): AccountType;
+//# sourceMappingURL=bankAccount.d.ts.map

package/dist/types/bankAccount.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bankAccount.d.ts","sourceRoot":"","sources":["../../src/bankAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAExE,oBAAY,WAAW;IACrB,eAAe,oBAAoB;IACnC,cAAc,mBAAmB;IACjC,mBAAmB,wBAAwB;IAC3C,iBAAiB,sBAAsB;IACvC,mBAAmB,wBAAwB;IAC3C,iBAAiB,sBAAsB;IACvC,qBAAqB,0BAA0B;IAC/C,mBAAmB,wBAAwB;IAC3C,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;CAChC;AAED,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,mBAAmB,CAAC,EAAE,mBAAmB,EAAE,CAAC;CAC7C,CAAC;AAEF,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,WAAW,CAWvE"}

package/dist/types/bankAnswer.d.ts

@@ -0,0 +1,6 @@
+export type BankAnswer = {
+    code: number;
+    text: string;
+    params?: string[];
+};
+//# sourceMappingURL=bankAnswer.d.ts.map

package/dist/types/bankAnswer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bankAnswer.d.ts","sourceRoot":"","sources":["../../src/bankAnswer.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}

package/dist/types/bankTransaction.d.ts

@@ -0,0 +1,6 @@
+export type BankTransaction = {
+    transId: string;
+    tanRequired: boolean;
+    versions: number[];
+};
+//# sourceMappingURL=bankTransaction.d.ts.map

package/dist/types/bankTransaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bankTransaction.d.ts","sourceRoot":"","sources":["../../src/bankTransaction.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC"}

package/dist/types/bankingInformation.d.ts

@@ -0,0 +1,20 @@
+import { BPD } from './bpd.js';
+import { UPD } from './upd.js';
+/**
+ * Information returned by the bank
+ * @property systemId The system ID provided by the bank for this client/product
+ * @property bpd The BPD (BankParameterDaten) contain general information
+ * @property upd The UPD (UserParameterDaten) contain user-specific information like the banking accounts
+ * @property bankMessages Messages from the bank which should be displayed to the user
+ */
+export type BankingInformation = {
+    systemId: string;
+    bpd?: BPD;
+    upd?: UPD;
+    bankMessages: BankMessage[];
+};
+export type BankMessage = {
+    subject: string;
+    text: string;
+};
+//# sourceMappingURL=bankingInformation.d.ts.map

package/dist/types/bankingInformation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bankingInformation.d.ts","sourceRoot":"","sources":["../../src/bankingInformation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAE/B;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,YAAY,EAAE,WAAW,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/types/bpd.d.ts

@@ -0,0 +1,17 @@
+import { BankTransaction } from './bankTransaction.js';
+import { Language } from './codes.js';
+import { TanMethod } from './tanMethod.js';
+export type BPD = {
+    version: number;
+    countryCode: number;
+    bankId: string;
+    bankName: string;
+    maxTransactionsPerMessage: number;
+    supportedLanguages: Language[];
+    supportedHbciVersions: number[];
+    url?: string;
+    supportedTanMethods: TanMethod[];
+    availableTanMethodIds: number[];
+    allowedTransactions: BankTransaction[];
+};
+//# sourceMappingURL=bpd.d.ts.map

package/dist/types/bpd.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bpd.d.ts","sourceRoot":"","sources":["../../src/bpd.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,MAAM,GAAG,GAAG;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB,EAAE,MAAM,CAAC;IAClC,kBAAkB,EAAE,QAAQ,EAAE,CAAC;IAC/B,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,mBAAmB,EAAE,SAAS,EAAE,CAAC;IACjC,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,mBAAmB,EAAE,eAAe,EAAE,CAAC;CACxC,CAAC"}

package/dist/types/client.d.ts

@@ -0,0 +1,86 @@
+import { StatementResponse } from './interactions/statementInteraction.js';
+import { AccountBalanceResponse } from './interactions/balanceInteraction.js';
+import { FinTSConfig } from './config.js';
+import { InitResponse } from './interactions/initDialogInteraction.js';
+import { TanMethod } from './tanMethod.js';
+export interface SynchronizeResponse extends InitResponse {
+}
+/**
+ * A client to communicate with a bank over the FinTS protocol
+ */
+export declare class FinTSClient {
+    config: FinTSConfig;
+    private openCustomerInteractions;
+    /**
+     * Creates a new FinTS client
+     * @param config - the configuration for the client, use the static factory methods FinTSConfig.forFirstTimeUse or FinTSConfig.fromBankingInformation to create a configuration
+     */
+    constructor(config: FinTSConfig);
+    /**
+     * Selects a TAN method by its ID
+     * @param tanMethodId - the ID of the TAN method to select, get the ID from FinTSClient.config.availableTanMethods
+     * @returns the selected TAN method
+     */
+    selectTanMethod(tanMethodId: number): TanMethod;
+    /**
+     * Selects a TAN media by its name
+     * @param tanMediaName - the name of the TAN media to select corresponding to a name in TanMethod.activeTanMedia
+     */
+    selectTanMedia(tanMediaName: string): void;
+    /**
+     * Synchronizes information with the bank, updating config.bankingInformation
+     * @returns the synchronization response
+     */
+    synchronize(): Promise<SynchronizeResponse>;
+    /**
+     * Continues the synchronization transaction when a TAN is required
+     * @param tanReference The TAN reference provided in the first call's response
+     * @param tan The TAN entered by the user
+     * @returns the synchronization response
+     */
+    synchronizeWithTan(tanReference: string, tan: string): Promise<SynchronizeResponse>;
+    /**
+     * Checks if the bank supports fetching an account balance in general or for the given account number when provided
+     * @param accountNumber when the account number is provided, checks if the account supports fetching the balance
+     * @returns true if the bank (and account) supports fetching the account balance
+     */
+    canGetAccountBalance(accountNumber?: string): boolean;
+    /**
+     * Fetches the account balance for the given account number
+     * @param accountNumber - the account number to fetch the balance for, must be an account available in the config.baningInformation.UPD.accounts
+     * @returns the account balance response
+     */
+    getAccountBalance(accountNumber: string): Promise<AccountBalanceResponse>;
+    /**
+     * Continues the account balance fetching when a TAN is required
+     * @param tanReference The TAN reference provided in the first call's response
+     * @param tan The TAN entered by the user
+     * @returns the account balance response
+     */
+    getAccountBalanceWithTan(tanReference: string, tan: string): Promise<AccountBalanceResponse>;
+    /**
+     * Checks if the bank supports fetching account statements in general or for the given account number when provided
+     * @param accountNumber when the account number is provided, checks if the account supports fetching of statements
+     * @returns true if the bank (and account) supports fetching account statements
+     */
+    canGetAccountStatements(accountNumber?: string): boolean;
+    /**
+     * Fetches the account statements for the given account number
+     * @param accountNumber - the account number to fetch the statements for, must be an account available in the config.baningInformation.UPD.accounts
+     * @param from - an optional start date of the period to fetch the statements for
+     * @param to - an optional end date of the period to fetch the statements for
+     * @returns an account statements response containing an array of statements
+     */
+    getAccountStatements(accountNumber: string, from?: Date, to?: Date): Promise<StatementResponse>;
+    /**
+     * Continues the account statements fetching when a TAN is required
+     * @param tanReference The TAN reference provided in the first call's response
+     * @param tan The TAN entered by the user
+     * @returns an account statements response containing an array of statements
+     */
+    getAccountStatementsWithTan(tanReference: string, tan: string): Promise<StatementResponse>;
+    private startCustomerOrderInteraction;
+    private continueCustomerInteractionWithTan;
+    private initDialog;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/types/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAwB,MAAM,wCAAwC,CAAC;AACjG,OAAO,EAAE,sBAAsB,EAAsB,MAAM,sCAAsC,CAAC;AAClG,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAyB,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAE9F,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAI3C,MAAM,WAAW,mBAAoB,SAAQ,YAAY;CAAG;AAE5D;;GAEG;AACH,qBAAa,WAAW;IAOH,MAAM,EAAE,WAAW;IANtC,OAAO,CAAC,wBAAwB,CAA0C;IAE1E;;;OAGG;gBACgB,MAAM,EAAE,WAAW;IAUtC;;;;OAIG;IACH,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS;IAK/C;;;OAGG;IACH,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAI1C;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAwBjD;;;;;OAKG;IACG,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAIzF;;;;OAIG;IACH,oBAAoB,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO;IAMrD;;;;OAIG;IACG,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAI/E;;;;;OAKG;IACG,wBAAwB,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAIlG;;;;OAIG;IACH,uBAAuB,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO;IAMxD;;;;;;OAMG;IACG,oBAAoB,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIrG;;;;;OAKG;IACG,2BAA2B,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;YAIlF,6BAA6B;YAqB7B,kCAAkC;YAiBlC,UAAU;CAUzB"}