lib-fints 1.4.8 → 1.5.0

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

@@ -1 +1 @@
-{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../../src/message.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAIlD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAa5C,OAAO,EAAE,KAAK,cAAc,EAAY,MAAM,qBAAqB,CAAC;AAEpE,qBAAa,OAAO;IACA,QAAQ,EAAE,OAAO,EAAE;gBAAnB,QAAQ,EAAE,OAAO,EAAE;IAEtC,WAAW,CAAC,CAAC,SAAS,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAKhE,eAAe,CAAC,CAAC,SAAS,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC,EAAE;IAI1D,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,cAAc,EAAE;IAO3D,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IASpC,oBAAoB,IAAI,MAAM;IAU9B,cAAc,IAAI,UAAU,EAAE;IA6B9B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,mBAAmB,CAAC,EAAE,MAAM,GAAG,OAAO;IAoBlE,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,mBAAmB,CAAC,EAAE,MAAM,GAAG,OAAO;IAiBzE,QAAQ,CAAC,cAAc,UAAQ,GAAG,MAAM;CAQxC;AAED,qBAAa,eAAgB,SAAQ,OAAO;IAC3C,mBAAmB,SAAK;gBAEZ,QAAQ,GAAE,MAAY,EAAE,KAAK,SAAI;IAiB7C,MAAM,IAAI,MAAM;IAwEhB,IAAI,CACH,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,QAAQ,CAAC,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,MAAM,EACpB,GAAG,CAAC,EAAE,MAAM;IAuCb,UAAU,CAAC,OAAO,EAAE,OAAO;CAS3B;AAED,qBAAa,oBAAqB,SAAQ,eAAe;IAEhD,UAAU,EAAE,MAAM;IAClB,kBAAkB,EAAE,MAAM;gBAD1B,UAAU,EAAE,MAAM,EAClB,kBAAkB,EAAE,MAAM,EACjC,QAAQ,GAAE,MAAY,EACtB,KAAK,SAAI;IAKV,IAAI,8BAA8B,IAAI,OAAO,CAG5C;CACD"}
+{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../../src/message.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAIlD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAa5C,OAAO,EAAE,KAAK,cAAc,EAAY,MAAM,qBAAqB,CAAC;AAEpE,qBAAa,OAAO;IACA,QAAQ,EAAE,OAAO,EAAE;gBAAnB,QAAQ,EAAE,OAAO,EAAE;IAEtC,WAAW,CAAC,CAAC,SAAS,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAKhE,eAAe,CAAC,CAAC,SAAS,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC,EAAE;IAI1D,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,cAAc,EAAE;IAO3D,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IASpC,oBAAoB,IAAI,MAAM;IAU9B,cAAc,IAAI,UAAU,EAAE;IA6B9B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,mBAAmB,CAAC,EAAE,MAAM,GAAG,OAAO;IAoBlE,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,mBAAmB,CAAC,EAAE,MAAM,GAAG,OAAO;IAqBzE,QAAQ,CAAC,cAAc,UAAQ,GAAG,MAAM;CAQxC;AAED,qBAAa,eAAgB,SAAQ,OAAO;IAC3C,mBAAmB,SAAK;gBAEZ,QAAQ,GAAE,MAAY,EAAE,KAAK,SAAI;IAiB7C,MAAM,IAAI,MAAM;IAwEhB,IAAI,CACH,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,QAAQ,CAAC,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,MAAM,EACpB,GAAG,CAAC,EAAE,MAAM;IAuCb,UAAU,CAAC,OAAO,EAAE,OAAO;CAS3B;AAED,qBAAa,oBAAqB,SAAQ,eAAe;IAEhD,UAAU,EAAE,MAAM;IAClB,kBAAkB,EAAE,MAAM;gBAD1B,UAAU,EAAE,MAAM,EAClB,kBAAkB,EAAE,MAAM,EACjC,QAAQ,GAAE,MAAY,EACtB,KAAK,SAAI;IAKV,IAAI,8BAA8B,IAAI,OAAO,CAG5C;CACD"}

package/dist/types/segments/HIEKA.d.ts

@@ -0,0 +1,52 @@
+import { AlphaNumeric } from '../dataElements/AlphaNumeric.js';
+import { Binary } from '../dataElements/Binary.js';
+import { Dat } from '../dataElements/Dat.js';
+import { Numeric } from '../dataElements/Numeric.js';
+import { DataGroup } from '../dataGroups/DataGroup.js';
+import type { Segment } from '../segment.js';
+import { SegmentDefinition } from '../segmentDefinition.js';
+import type { StatementFormat } from './HKEKA.js';
+export type HIEKASegment = Segment & {
+    format: StatementFormat;
+    timeRange?: {
+        from?: Date;
+        to?: Date;
+    };
+    date?: Date;
+    year?: number;
+    number?: number;
+    /** The statement document itself — a PDF when format is '3' */
+    booked: string;
+    closingInfo?: string;
+    conditionsInfo?: string;
+    advertisement?: string;
+    iban?: string;
+    bic?: string;
+    name?: string;
+    name2?: string;
+    name3?: string;
+    /** Receipt to acknowledge the statement with, when the bank requires acknowledgement */
+    receipt?: string;
+};
+/**
+ * Electronic account statement response (Elektronischer Kontoauszug)
+ *
+ * The element order follows the FinTS 3.0 specification, and two details of it are easy
+ * to get wrong:
+ *
+ * - `booked` sits AFTER date/year/number, not before them. HIEKP v2 orders the same
+ *   fields the other way round — the order is specific to each segment and cannot be
+ *   carried over from one to the other.
+ * - Only version 5 carries date/year/number at all; up to version 4 `booked` follows
+ *   the time range directly, and version 1 has no iban/bic/name either. Decoding an
+ *   older response with the version 5 layout does not fail, it silently shifts every
+ *   field by three positions and hands out the advertisement text as the document.
+ */
+export declare class HIEKA extends SegmentDefinition {
+    static Id: string;
+    static Version: number;
+    constructor();
+    version: number;
+    elements: (AlphaNumeric | DataGroup | Numeric | Binary | Dat)[];
+}
+//# sourceMappingURL=HIEKA.d.ts.map

package/dist/types/segments/HIEKA.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HIEKA.d.ts","sourceRoot":"","sources":["../../../src/segments/HIEKA.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG;IACpC,MAAM,EAAE,eAAe,CAAC;IACxB,SAAS,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,IAAI,CAAC;QAAC,EAAE,CAAC,EAAE,IAAI,CAAA;KAAE,CAAC;IACvC,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wFAAwF;IACxF,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,qBAAa,KAAM,SAAQ,iBAAiB;IAC3C,MAAM,CAAC,EAAE,SAAW;IACpB,MAAM,CAAC,OAAO,SAAK;;IAInB,OAAO,SAAiB;IACxB,QAAQ,wDAgBN;CACF"}

package/dist/types/segments/HIEKAS.d.ts

@@ -0,0 +1,21 @@
+import { BusinessTransactionParameter, type BusinessTransactionParameterSegment } from './businessTransactionParameter.js';
+export type HIEKASSegment = BusinessTransactionParameterSegment<HIEKASParameter>;
+export type HIEKASParameter = {
+    /** Whether a specific statement may be requested by number and year */
+    indexAllowed: boolean;
+    /** Whether the bank expects each fetched statement to be acknowledged with its receipt */
+    receiptRequired: boolean;
+    /** Whether the number of entries may be limited */
+    maxEntryCountAllowed: boolean;
+    /** The statement formats the bank supports, see StatementFormat */
+    supportedFormats: string[];
+};
+/**
+ * Parameters for the HKEKA business transaction (electronic account statements)
+ */
+export declare class HIEKAS extends BusinessTransactionParameter {
+    static Id: string;
+    version: number;
+    constructor();
+}
+//# sourceMappingURL=HIEKAS.d.ts.map

package/dist/types/segments/HIEKAS.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HIEKAS.d.ts","sourceRoot":"","sources":["../../../src/segments/HIEKAS.ts"],"names":[],"mappings":"AAEA,OAAO,EACN,4BAA4B,EAC5B,KAAK,mCAAmC,EACxC,MAAM,mCAAmC,CAAC;AAE3C,MAAM,MAAM,aAAa,GAAG,mCAAmC,CAAC,eAAe,CAAC,CAAC;AAEjF,MAAM,MAAM,eAAe,GAAG;IAC7B,uEAAuE;IACvE,YAAY,EAAE,OAAO,CAAC;IACtB,0FAA0F;IAC1F,eAAe,EAAE,OAAO,CAAC;IACzB,mDAAmD;IACnD,oBAAoB,EAAE,OAAO,CAAC;IAC9B,mEAAmE;IACnE,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,qBAAa,MAAO,SAAQ,4BAA4B;IACvD,MAAM,CAAC,EAAE,SAAY;IACrB,OAAO,SAAK;;CAUZ"}

package/dist/types/segments/HKEKA.d.ts

@@ -0,0 +1,54 @@
+import { AlphaNumeric } from '../dataElements/AlphaNumeric.js';
+import { Numeric } from '../dataElements/Numeric.js';
+import { type Account, AccountGroup } from '../dataGroups/Account.js';
+import { type InternationalAccount, InternationalAccountGroup } from '../dataGroups/InternationalAccount.js';
+import type { Segment } from '../segment.js';
+import { SegmentDefinition } from '../segmentDefinition.js';
+/**
+ * Format of the electronic account statement.
+ * The bank announces the formats it supports in the HIEKAS parameters.
+ */
+export declare enum StatementFormat {
+    MT940 = "1",
+    ISO8583 = "2",
+    PDF = "3"
+}
+export type HKEKASegment = Segment & {
+    /** National account connection up to version 3, international from version 4 on */
+    account: Account | InternationalAccount;
+    statementFormat?: StatementFormat;
+    /** The sequential number of the statement to fetch, only allowed when the bank sets `indexAllowed` */
+    statementNumber?: number;
+    /** The year the statement number refers to, not available before version 3 */
+    statementYear?: number;
+    maxEntries?: number;
+    /**
+     * The offset ("Aufsetzpunkt") the bank returned with answer code 3040, to fetch the
+     * next statement.
+     *
+     * This is deliberately NOT named `continuationMark`: for HKEKA the bank does not split
+     * one oversized response across messages, it announces that a *further document* is
+     * waiting. Naming it `continuationMark` would make the generic parted-message handling
+     * splice two complete HIEKA segments into one corrupt segment.
+     */
+    offset?: string;
+};
+/**
+ * Request an electronic account statement (Elektronischer Kontoauszug)
+ *
+ * Unlike HKKAZ/HKCAZ this does not return individual transactions but the statement
+ * document the bank files in the customer's electronic mailbox — for most banks a PDF.
+ *
+ * A statement is handed out once: the bank keeps track of which statements have already
+ * been fetched and announces remaining ones with answer code 3040 plus an offset. Banks
+ * that set `receiptRequired` in their HIEKAS parameters expect each statement to be
+ * acknowledged before they consider it delivered.
+ */
+export declare class HKEKA extends SegmentDefinition {
+    static Id: string;
+    static Version: number;
+    constructor();
+    version: number;
+    elements: (AlphaNumeric | AccountGroup | Numeric | InternationalAccountGroup)[];
+}
+//# sourceMappingURL=HKEKA.d.ts.map

package/dist/types/segments/HKEKA.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HKEKA.d.ts","sourceRoot":"","sources":["../../../src/segments/HKEKA.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAE,KAAK,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACtE,OAAO,EACN,KAAK,oBAAoB,EACzB,yBAAyB,EACzB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE5D;;;GAGG;AACH,oBAAY,eAAe;IAC1B,KAAK,MAAM;IACX,OAAO,MAAM;IACb,GAAG,MAAM;CACT;AAED,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG;IACpC,mFAAmF;IACnF,OAAO,EAAE,OAAO,GAAG,oBAAoB,CAAC;IACxC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,sGAAsG;IACtG,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,8EAA8E;IAC9E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,qBAAa,KAAM,SAAQ,iBAAiB;IAC3C,MAAM,CAAC,EAAE,SAAW;IACpB,MAAM,CAAC,OAAO,SAAK;;IAInB,OAAO,SAAiB;IACxB,QAAQ,wEAQN;CACF"}

package/dist/types/segments/registry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../../src/segments/registry.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AA4CjE,wBAAgB,gBAAgB,SA4C/B;AAED,wBAAgB,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAE9E"}
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../../src/segments/registry.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AA+CjE,wBAAgB,gBAAgB,SA+C/B;AAED,wBAAgB,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAE9E"}

package/dist/types/tests/HKEKA.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=HKEKA.test.d.ts.map

package/dist/types/tests/HKEKA.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HKEKA.test.d.ts","sourceRoot":"","sources":["../../../src/tests/HKEKA.test.ts"],"names":[],"mappings":""}

package/dist/types/tests/partedResponse.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=partedResponse.test.d.ts.map

package/dist/types/tests/partedResponse.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"partedResponse.test.d.ts","sourceRoot":"","sources":["../../../src/tests/partedResponse.test.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "lib-fints",
-	"version": "1.4.8",
+	"version": "1.5.0",
 	"description": "Typescript/Javascript client library for Online-Banking via the FinTS 3.0 protocol with PIN/TAN",
 	"engines": {
 		"node": ">=18.0.0"
@@ -42,7 +42,7 @@
 		"@biomejs/biome": "2.3.10",
 		"@types/node": "^20.19.41",
 		"typescript": "^5.9.3",
-		"vitest": "^4.0.18"
+		"vitest": "^4.1.10"
 	},
 	"dependencies": {
 		"fast-xml-parser": "^5.8.0"