fints-lib 0.6.0 → 0.7.0

package/dist/request.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Request = exports.RequestConfig = void 0;
+const segments_1 = require("./segments");
+const constants_1 = require("./constants");
+/**
+ * Properties used to constructe a `Request`.
+ */
+class RequestConfig {
+    constructor() {
+        /**
+         * A list of allowed TAN methods as configured by the server.
+         */
+        this.tanMethods = [];
+        /**
+         * All segments that should be transmitted in the HNVSD segment of the request.
+         */
+        this.segments = [];
+    }
+}
+exports.RequestConfig = RequestConfig;
+/**
+ * A single request holding multiple segments.
+ * Will likely embedded in a dialog.
+ */
+class Request extends RequestConfig {
+    constructor(config) {
+        super();
+        Object.assign(this, config);
+        // Generate `this.secRef`.
+        this.secRef = Math.floor(1000000 + Math.random() * 8999999);
+    }
+    /**
+     * Determines if a TAN method with a "999" security function is available.
+     * This determines whether profile version 2 can be used.
+     */
+    get hasNo999SecurityFunction() {
+        return this.tanMethods.length > 0 && !this.tanMethods.some((method) => method.securityFunction === "999");
+    }
+    /**
+     * Use security profile version 2 if the server supports it.
+     * Will be `1` or `2`, depending on the server's capabilities.
+     */
+    get profileVersion() {
+        return this.hasNo999SecurityFunction ? 2 : 1;
+    }
+    /**
+     * Determines the security function to use. Will default to the first one if the "999" security function is
+     * unavailable.
+     */
+    get securityFunction() {
+        return this.hasNo999SecurityFunction ? this.tanMethods[0].securityFunction : "999";
+    }
+    /**
+     * Returns the total number of segments in this request, including all header meta segments.
+     */
+    get segmentCount() {
+        // Add `3` because of:
+        // - Not zero-based (0)
+        // - HNHBK (1)
+        // - HNSHK (2)
+        return this.segments.length + 3;
+    }
+    /**
+     * An array of all segments, including the HNVSD segment wrapping the user payload segments.
+     */
+    get fullSegments() {
+        const { dialogId, secRef, blz, name, systemId, profileVersion, segmentCount, msgNo, pin, tan, securityFunction, } = this;
+        const segmentsWithoutHeader = [
+            new segments_1.HNVSK({ segNo: 998, blz, name, systemId, profileVersion }),
+            new segments_1.HNVSD({
+                segNo: 999,
+                segments: [
+                    new segments_1.HNSHK({ segNo: 2, secRef, blz, name, systemId, profileVersion, securityFunction }),
+                    ...this.segments,
+                    new segments_1.HNSHA({ segNo: segmentCount, secRef, pin, tan }),
+                ],
+            }),
+            // Add `1` to the index because of HNSHA.
+            new segments_1.HNHBS({ segNo: segmentCount + 1, msgNo }),
+        ];
+        let length = segmentsWithoutHeader.reduce((result, segment) => result + String(segment).length, 0) +
+            constants_1.HEADER_LENGTH +
+            dialogId.length +
+            String(msgNo).length;
+        return [new segments_1.HNHBK({ segNo: 1, msgLength: length, dialogId, msgNo }), ...segmentsWithoutHeader];
+    }
+    /**
+     * Generate a textual representation for debug purposes.
+     */
+    get debugString() {
+        return this.segments.map((segment) => segment.debugString).join("\n");
+    }
+    /**
+     * Serialize the whole request into a string that can be sent to the server.
+     */
+    toString() {
+        return this.fullSegments.map((segment) => String(segment)).join("");
+    }
+}
+exports.Request = Request;
+//# sourceMappingURL=request.js.map

package/dist/request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../src/request.ts"],"names":[],"mappings":";;;AAAA,yCAA+E;AAE/E,2CAA4C;AAE5C;;GAEG;AACH,MAAa,aAAa;IAA1B;QAgCI;;WAEG;QACI,eAAU,GAAgB,EAAE,CAAC;QACpC;;WAEG;QACI,aAAQ,GAAmB,EAAE,CAAC;IACzC,CAAC;CAAA;AAxCD,sCAwCC;AAED;;;GAGG;AACH,MAAa,OAAQ,SAAQ,aAAa;IAQtC,YAAY,MAA8B;QACtC,KAAK,EAAE,CAAC;QACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC5B,0BAA0B;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;OAGG;IACH,IAAY,wBAAwB;QAChC,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,gBAAgB,KAAK,KAAK,CAAC,CAAC;IAC9G,CAAC;IAED;;;OAGG;IACH,IAAY,cAAc;QACtB,OAAO,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,IAAY,gBAAgB;QACxB,OAAO,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,IAAY,YAAY;QACpB,sBAAsB;QACtB,uBAAuB;QACvB,cAAc;QACd,cAAc;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAY,YAAY;QACpB,MAAM,EACF,QAAQ,EACR,MAAM,EACN,GAAG,EACH,IAAI,EACJ,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,KAAK,EACL,GAAG,EACH,GAAG,EACH,gBAAgB,GACnB,GAAG,IAAI,CAAC;QACT,MAAM,qBAAqB,GAAG;YAC1B,IAAI,gBAAK,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC;YAC9D,IAAI,gBAAK,CAAC;gBACN,KAAK,EAAE,GAAG;gBACV,QAAQ,EAAE;oBACN,IAAI,gBAAK,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,cAAc,EAAE,gBAAgB,EAAE,CAAC;oBACtF,GAAG,IAAI,CAAC,QAAQ;oBAChB,IAAI,gBAAK,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;iBACvD;aACJ,CAAC;YACF,yCAAyC;YACzC,IAAI,gBAAK,CAAC,EAAE,KAAK,EAAE,YAAY,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC;SAChD,CAAC;QACF,IAAI,MAAM,GACN,qBAAqB,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;YACrF,yBAAa;YACb,QAAQ,CAAC,MAAM;YACf,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC;QACzB,OAAO,CAAC,IAAI,gBAAK,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,qBAAqB,CAAC,CAAC;IACnG,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACI,QAAQ;QACX,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACxE,CAAC;CACJ;AArGD,0BAqGC"}

package/dist/response.d.ts

@@ -0,0 +1,104 @@
+import { Segment, HIRMS, HIRMG } from "./segments";
+import { Constructable } from "./types";
+import { ReturnValue } from "./return-value";
+import { Request } from "./request";
+import { TanMethod } from "./tan-method";
+/**
+ * A wrapper class for on-demand parsing a response received from the server.
+ */
+export declare class Response {
+    /**
+     * A list of all segments with all data groups with all data elements.
+     */
+    private segmentStrings;
+    constructor(data: string);
+    /**
+     * Find all segments with the specified segment class.
+     *
+     * @param segmentClass A segment's class. The response should be searched for all segments with a matching type.
+     *
+     * @return An array of all matching segments. Can be empty if no segements matched the specified type.
+     */
+    findSegments<T extends Segment<any>>(segmentClass: Constructable<T>): T[];
+    /**
+     * Find the first segment with the specified segment class.
+     *
+     * @param segmentClass A segment's class. The response should be searched for a segments with a matching type.
+     *
+     * @return The deserialized matching segment. Can be `undefined` if no segement matched the specified type.
+     */
+    findSegment<T extends Segment<any>>(segmentClass: Constructable<T>): T;
+    /**
+     * Will be true if the request this response references was a success and no errors were found.
+     * Responses containing warnings will always be treated as being successfully.
+     */
+    get success(): boolean;
+    /**
+     * An array with all error messages received from the server.
+     */
+    get errors(): string[];
+    /**
+     * Shorthand for extracting the dialog's id from the HNHBK segment.
+     * If no HNHBK segment was found, an error will be thrown.
+     */
+    get dialogId(): string;
+    /**
+     * Shorthand for retrieving the bank's name from the HIBPA segment.
+     * Will return `undefined` if no HIBPA segment was found.
+     */
+    get bankName(): string;
+    /**
+     * Shorthand for extracting the system's id from the HISYN segment.
+     * If no HISYN segment was found, an error will be thrown.
+     */
+    get systemId(): string;
+    /**
+     * Will return a set of return values from either only HIRMG or HIRMS segments or both.
+     * A return value is a set of a return code identifying it as well as a human readable message.
+     *
+     * @param segmentClasses Either HIRMG, HIRMS or both. Denotes which segment's return values should be processed.
+     *
+     * @return A map of (code -> return value).
+     */
+    returnValues(...segmentClasses: Constructable<HIRMG | HIRMS>[]): Map<string, ReturnValue>;
+    /**
+     * Will assemble a list of all supported TAN methods.
+     */
+    get supportedTanMethods(): TanMethod[];
+    /**
+     * Will assemble a list of all supported SEPA pain-message formats.
+     */
+    get painFormats(): string[];
+    /**
+     * Segments can reference each other.
+     * Will find the segment of the specified class referencing the specified segment.
+     *
+     * @param segmentClass Ignore all sections except for segments of this type.
+     * @param segment Find the segment in the current message that references the segment specified in this parameter.
+     *
+     * @return All segments of the specified type that reference the provided segment. Might be an empty array.
+     */
+    findSegmentForReference<T extends Segment<any>>(segmentClass: Constructable<T>, segment: Segment<any>): T;
+    /**
+     * Returns touchdowns contained in this message. Touchdowns are used for listing statements if the statement list
+     * needed to be split into multiple requests.
+     * The touchdowns are used for identifying from what request the list of statement was continued in this response.
+     *
+     * @param request The request for which the touchdown should be found.
+     *
+     * @return A map of (segment type -> touchdown identifier).
+     */
+    getTouchdowns(request: Request): Map<string, string>;
+    /**
+     * Will return the maximum version for the specified segment type in this message.
+     *
+     * @param segment The class of segments for which the maximum version should be found.
+     *
+     * @return The maximum version of the specified segment class version, or `0` if no segment was found.
+     */
+    segmentMaxVersion(segment: Constructable<Segment<any>>): number;
+    /**
+     * Generate a textual representation for debug purposes.
+     */
+    get debugString(): string;
+}

package/dist/response.js

@@ -0,0 +1,197 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Response = void 0;
+const segments_1 = require("./segments");
+const utils_1 = require("./utils");
+/**
+ * A wrapper class for on-demand parsing a response received from the server.
+ */
+class Response {
+    constructor(data) {
+        this.segmentStrings = (0, utils_1.parse)(data);
+        const hnvsd = this.findSegment(segments_1.HNVSD);
+        if (hnvsd) {
+            this.segmentStrings.push(...hnvsd.rawSegments);
+        }
+    }
+    /**
+     * Find all segments with the specified segment class.
+     *
+     * @param segmentClass A segment's class. The response should be searched for all segments with a matching type.
+     *
+     * @return An array of all matching segments. Can be empty if no segements matched the specified type.
+     */
+    findSegments(segmentClass) {
+        const matchingStrings = this.segmentStrings.filter((str) => str[0][0] === segmentClass.name);
+        return matchingStrings.map((segmentString) => {
+            const segment = new segmentClass(segmentString);
+            if (segment.type !== segmentClass.name) {
+                throw new Error(`Consistency check failed. Deserializing ${segmentClass.name} returned ${segment.type}.`);
+            }
+            return segment;
+        });
+    }
+    /**
+     * Find the first segment with the specified segment class.
+     *
+     * @param segmentClass A segment's class. The response should be searched for a segments with a matching type.
+     *
+     * @return The deserialized matching segment. Can be `undefined` if no segement matched the specified type.
+     */
+    findSegment(segmentClass) {
+        const segments = this.findSegments(segmentClass);
+        return segments[0];
+    }
+    /**
+     * Will be true if the request this response references was a success and no errors were found.
+     * Responses containing warnings will always be treated as being successfully.
+     */
+    get success() {
+        return !Array.from(this.returnValues().values()).some((value) => value.error);
+    }
+    /**
+     * An array with all error messages received from the server.
+     */
+    get errors() {
+        return Array.from(this.returnValues().values())
+            .filter((value) => value.error)
+            .map((value) => `${value.code} ${value.message}`);
+    }
+    /**
+     * Shorthand for extracting the dialog's id from the HNHBK segment.
+     * If no HNHBK segment was found, an error will be thrown.
+     */
+    get dialogId() {
+        const segment = this.findSegment(segments_1.HNHBK);
+        if (!segment) {
+            throw new Error('Invalid response. Missing "HNHBK" segment.');
+        }
+        return segment.dialogId;
+    }
+    /**
+     * Shorthand for retrieving the bank's name from the HIBPA segment.
+     * Will return `undefined` if no HIBPA segment was found.
+     */
+    get bankName() {
+        const segment = this.findSegment(segments_1.HIBPA);
+        if (segment) {
+            return segment.bankName;
+        }
+        return undefined;
+    }
+    /**
+     * Shorthand for extracting the system's id from the HISYN segment.
+     * If no HISYN segment was found, an error will be thrown.
+     */
+    get systemId() {
+        const segment = this.findSegment(segments_1.HISYN);
+        if (!segment) {
+            throw new Error("Invalid response. Could not find system id.");
+        }
+        return segment.systemId;
+    }
+    /**
+     * Will return a set of return values from either only HIRMG or HIRMS segments or both.
+     * A return value is a set of a return code identifying it as well as a human readable message.
+     *
+     * @param segmentClasses Either HIRMG, HIRMS or both. Denotes which segment's return values should be processed.
+     *
+     * @return A map of (code -> return value).
+     */
+    returnValues(...segmentClasses) {
+        const classes = segmentClasses.length === 0 ? [segments_1.HIRMG, segments_1.HIRMS] : segmentClasses;
+        return classes.reduce((result, currentClass) => {
+            const segment = this.findSegment(currentClass);
+            if (!segment) {
+                return result;
+            }
+            segment.returnValues.forEach((value, key) => result.set(key, value));
+            return result;
+        }, new Map());
+    }
+    /**
+     * Will assemble a list of all supported TAN methods.
+     */
+    get supportedTanMethods() {
+        const hirms = this.findSegments(segments_1.HIRMS).find((segment) => segment.returnValues.has("3920"));
+        const securityFunctions = hirms.returnValues.get("3920").parameters;
+        const tanSegments = this.findSegments(segments_1.HITANS);
+        return tanSegments.reduce((result, segment) => {
+            segment.tanMethods.forEach((tanMethod) => {
+                if (securityFunctions.includes(tanMethod.securityFunction)) {
+                    result.push(tanMethod);
+                }
+            });
+            return result;
+        }, []);
+    }
+    /**
+     * Will assemble a list of all supported SEPA pain-message formats.
+     */
+    get painFormats() {
+        return this.findSegment(segments_1.HISPAS).painFormats;
+    }
+    /**
+     * Segments can reference each other.
+     * Will find the segment of the specified class referencing the specified segment.
+     *
+     * @param segmentClass Ignore all sections except for segments of this type.
+     * @param segment Find the segment in the current message that references the segment specified in this parameter.
+     *
+     * @return All segments of the specified type that reference the provided segment. Might be an empty array.
+     */
+    findSegmentForReference(segmentClass, segment) {
+        return this.findSegments(segmentClass).find((current) => current.reference === segment.segNo);
+    }
+    /**
+     * Returns touchdowns contained in this message. Touchdowns are used for listing statements if the statement list
+     * needed to be split into multiple requests.
+     * The touchdowns are used for identifying from what request the list of statement was continued in this response.
+     *
+     * @param request The request for which the touchdown should be found.
+     *
+     * @return A map of (segment type -> touchdown identifier).
+     */
+    getTouchdowns(request) {
+        return request.segments.reduce((result, requestSegment) => {
+            const segment = this.findSegmentForReference(segments_1.HIRMS, requestSegment);
+            if (segment) {
+                const returnValue = segment.returnValues.get("3040");
+                if (returnValue) {
+                    result.set(requestSegment.type, returnValue.parameters[0]);
+                }
+            }
+            return result;
+        }, new Map());
+    }
+    /**
+     * Will return the maximum version for the specified segment type in this message.
+     *
+     * @param segment The class of segments for which the maximum version should be found.
+     *
+     * @return The maximum version of the specified segment class version, or `0` if no segment was found.
+     */
+    segmentMaxVersion(segment) {
+        return this.findSegments(segment).reduce((max, current) => (current.version > max ? current.version : max), 0);
+    }
+    /**
+     * Generate a textual representation for debug purposes.
+     */
+    get debugString() {
+        return this.segmentStrings
+            .map((segmentString) => {
+            const split = segmentString;
+            return (`Type: ${split[0][0]}\n` +
+                `Version: ${split[0][2]}\n` +
+                `Segment Number: ${split[0][1]}\n` +
+                `Referencing: ${split[0].length <= 3 ? "None" : split[0][3]}\n` +
+                `----\n` +
+                split.slice(1).reduce((result, group, index) => {
+                    return result + `DG ${index}: ${Array.isArray(group) ? group.join(", ") : group}\n`;
+                }, ""));
+        })
+            .join("\n");
+    }
+}
+exports.Response = Response;
+//# sourceMappingURL=response.js.map

package/dist/response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.js","sourceRoot":"","sources":["../src/response.ts"],"names":[],"mappings":";;;AAAA,yCAA+F;AAI/F,mCAAgC;AAGhC;;GAEG;AACH,MAAa,QAAQ;IAMjB,YAAY,IAAY;QACpB,IAAI,CAAC,cAAc,GAAG,IAAA,aAAK,EAAC,IAAI,CAAC,CAAC;QAClC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,gBAAK,CAAC,CAAC;QACtC,IAAI,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;QACnD,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,YAAY,CAAyB,YAA8B;QACtE,MAAM,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;QAC7F,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE;YACzC,MAAM,OAAO,GAAG,IAAI,YAAY,CAAC,aAAa,CAAC,CAAC;YAChD,IAAI,OAAO,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI,EAAE,CAAC;gBACrC,MAAM,IAAI,KAAK,CACX,2CAA2C,YAAY,CAAC,IAAI,aAAa,OAAO,CAAC,IAAI,GAAG,CAC3F,CAAC;YACN,CAAC;YACD,OAAO,OAAO,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAAyB,YAA8B;QACrE,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,IAAW,OAAO;QACd,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QACb,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,CAAC;aAC1C,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;aAC9B,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,IAAW,QAAQ;QACf,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,gBAAK,CAAC,CAAC;QACxC,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAClE,CAAC;QACD,OAAO,OAAO,CAAC,QAAQ,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,IAAW,QAAQ;QACf,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,gBAAK,CAAC,CAAC;QACxC,IAAI,OAAO,EAAE,CAAC;YACV,OAAO,OAAO,CAAC,QAAQ,CAAC;QAC5B,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,IAAW,QAAQ;QACf,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,gBAAK,CAAC,CAAC;QACxC,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACnE,CAAC;QACD,OAAO,OAAO,CAAC,QAAQ,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACI,YAAY,CAAC,GAAG,cAA8C;QACjE,MAAM,OAAO,GAAG,cAAc,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAK,EAAE,gBAAK,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;QAC9E,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE;YAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YAC/C,IAAI,CAAC,OAAO,EAAE,CAAC;gBACX,OAAO,MAAM,CAAC;YAClB,CAAC;YACD,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;YACrE,OAAO,MAAM,CAAC;QAClB,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,IAAW,mBAAmB;QAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,gBAAK,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3F,MAAM,iBAAiB,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC;QACpE,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,iBAAM,CAAC,CAAC;QAC9C,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE;YAC1C,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBACrC,IAAI,iBAAiB,CAAC,QAAQ,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,CAAC;oBACzD,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC3B,CAAC;YACL,CAAC,CAAC,CAAC;YACH,OAAO,MAAM,CAAC;QAClB,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QAClB,OAAO,IAAI,CAAC,WAAW,CAAC,iBAAM,CAAC,CAAC,WAAW,CAAC;IAChD,CAAC;IAED;;;;;;;;OAQG;IACI,uBAAuB,CAAyB,YAA8B,EAAE,OAAqB;QACxG,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,KAAK,OAAO,CAAC,KAAK,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;OAQG;IACI,aAAa,CAAC,OAAgB;QACjC,OAAO,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,cAAc,EAAE,EAAE;YACtD,MAAM,OAAO,GAAG,IAAI,CAAC,uBAAuB,CAAC,gBAAK,EAAE,cAAc,CAAC,CAAC;YACpE,IAAI,OAAO,EAAE,CAAC;gBACV,MAAM,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACrD,IAAI,WAAW,EAAE,CAAC;oBACd,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC/D,CAAC;YACL,CAAC;YACD,OAAO,MAAM,CAAC;QAClB,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACI,iBAAiB,CAAC,OAAoC;QACzD,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IACnH,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QAClB,OAAO,IAAI,CAAC,cAAc;aACrB,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE;YACnB,MAAM,KAAK,GAAG,aAAa,CAAC;YAC5B,OAAO,CACH,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI;gBACxB,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI;gBAC3B,mBAAmB,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI;gBAClC,gBAAgB,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI;gBAC/D,QAAQ;gBACR,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;oBAC3C,OAAO,MAAM,GAAG,MAAM,KAAK,KAAK,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;gBACxF,CAAC,EAAE,EAAE,CAAC,CACT,CAAC;QACN,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;CACJ;AAjND,4BAiNC"}

package/dist/return-value.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Wraps a return value used in the HIRMG and HIRMS segments.
+ */
+export declare class ReturnValue {
+    /**
+     * The return value's code.
+     * Identifies the purpose of the return value and also specifies whether it's a notification of succes,
+     * a warning or an error.
+     */
+    code: string;
+    /**
+     * A human readable message.
+     */
+    message: string;
+    /**
+     * Arbitrary parameters.
+     */
+    parameters: string[];
+    /**
+     * A return value might reference a set of certain segments of a referenced request, for example if it
+     * was a warning or an error in a HIRMS segment.
+     */
+    references: number[];
+    constructor(props: Partial<ReturnValue>);
+    /**
+     * Will be `true` if the return value was a successful one (code starts with "0").
+     */
+    get success(): boolean;
+    /**
+     * Will be `true` if the return value was warning (code starts with "3").
+     */
+    get warning(): boolean;
+    /**
+     * Will be `true` if the return value was an error (code starts with "9").
+     */
+    get error(): boolean;
+}

package/dist/return-value.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReturnValue = void 0;
+/**
+ * Wraps a return value used in the HIRMG and HIRMS segments.
+ */
+class ReturnValue {
+    constructor(props) {
+        Object.assign(this, props);
+    }
+    /**
+     * Will be `true` if the return value was a successful one (code starts with "0").
+     */
+    get success() {
+        return String(this.code).startsWith("0");
+    }
+    /**
+     * Will be `true` if the return value was warning (code starts with "3").
+     */
+    get warning() {
+        return String(this.code).startsWith("3");
+    }
+    /**
+     * Will be `true` if the return value was an error (code starts with "9").
+     */
+    get error() {
+        return String(this.code).startsWith("9");
+    }
+}
+exports.ReturnValue = ReturnValue;
+//# sourceMappingURL=return-value.js.map

package/dist/return-value.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"return-value.js","sourceRoot":"","sources":["../src/return-value.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAa,WAAW;IAqBpB,YAAY,KAA2B;QACnC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QACd,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IACD;;OAEG;IACH,IAAW,OAAO;QACd,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IACD;;OAEG;IACH,IAAW,KAAK;QACZ,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;CACJ;AA3CD,kCA2CC"}

package/dist/segments/hibpa.d.ts

@@ -0,0 +1,22 @@
+export declare class HIBPAProps {
+    segNo: number;
+    bpdVersion: number;
+    countryCode: number;
+    blz: string;
+    bankName: string;
+    transactionTypeCount: number;
+    supportedLanguages: number[];
+    supportedHbciVersions: number[];
+}
+declare const HIBPA_base: import("..").Constructable<HIBPAProps & import("./segment").Segment<HIBPAProps>>;
+/**
+ * HIBPA (Bankparameter allgemein)
+ * Section D.2
+ */
+export declare class HIBPA extends HIBPA_base {
+    type: string;
+    protected defaults(): void;
+    protected serialize(): string[][];
+    protected deserialize(input: string[][]): void;
+}
+export {};

package/dist/segments/hibpa.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HIBPA = exports.HIBPAProps = void 0;
+const parse_1 = require("../parse");
+const segment_1 = require("./segment");
+class HIBPAProps {
+}
+exports.HIBPAProps = HIBPAProps;
+/**
+ * HIBPA (Bankparameter allgemein)
+ * Section D.2
+ */
+class HIBPA extends (0, segment_1.SegmentClass)(HIBPAProps) {
+    constructor() {
+        super(...arguments);
+        this.type = "HIBPA";
+    }
+    defaults() {
+        this.version = 3;
+    }
+    serialize() {
+        throw new Error("Not implemented.");
+    }
+    deserialize(input) {
+        const [[bpdVersion], [countryCode, blz], [bankName], [transactionTypeCount], supportedLanguages, supportedHbciVersions,] = input;
+        this.bpdVersion = parse_1.Parse.num(bpdVersion);
+        this.countryCode = parse_1.Parse.num(countryCode);
+        this.blz = blz;
+        this.bankName = bankName;
+        this.transactionTypeCount = parse_1.Parse.num(transactionTypeCount);
+        this.supportedLanguages = supportedLanguages.map(parse_1.Parse.num);
+        this.supportedHbciVersions = supportedHbciVersions.map(parse_1.Parse.num);
+    }
+}
+exports.HIBPA = HIBPA;
+//# sourceMappingURL=hibpa.js.map

package/dist/segments/hibpa.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hibpa.js","sourceRoot":"","sources":["../../src/segments/hibpa.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,uCAAyC;AAEzC,MAAa,UAAU;CAStB;AATD,gCASC;AAED;;;GAGG;AACH,MAAa,KAAM,SAAQ,IAAA,sBAAY,EAAC,UAAU,CAAC;IAAnD;;QACW,SAAI,GAAG,OAAO,CAAC;IA2B1B,CAAC;IAzBa,QAAQ;QACd,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;IACrB,CAAC;IAES,SAAS;QACf,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxC,CAAC;IAES,WAAW,CAAC,KAAiB;QACnC,MAAM,CACF,CAAC,UAAU,CAAC,EACZ,CAAC,WAAW,EAAE,GAAG,CAAC,EAClB,CAAC,QAAQ,CAAC,EACV,CAAC,oBAAoB,CAAC,EACtB,kBAAkB,EAClB,qBAAqB,EACxB,GAAG,KAAK,CAAC;QACV,IAAI,CAAC,UAAU,GAAG,aAAK,CAAC,GAAG,CAAC,UAAoB,CAAC,CAAC;QAClD,IAAI,CAAC,WAAW,GAAG,aAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC1C,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,QAAkB,CAAC;QACnC,IAAI,CAAC,oBAAoB,GAAG,aAAK,CAAC,GAAG,CAAC,oBAA8B,CAAC,CAAC;QACtE,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC,GAAG,CAAC,aAAK,CAAC,GAAG,CAAC,CAAC;QAC5D,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC,GAAG,CAAC,aAAK,CAAC,GAAG,CAAC,CAAC;IACtE,CAAC;CACJ;AA5BD,sBA4BC"}

package/dist/segments/hiccs.d.ts

@@ -0,0 +1,14 @@
+export declare class HICCSProps {
+    segNo: number;
+    taskId?: string;
+}
+declare const HICCS_base: import("..").Constructable<HICCSProps & import("./segment").Segment<HICCSProps>>;
+/**
+ * HICCS (SEPA credit transfer acknowledgement)
+ */
+export declare class HICCS extends HICCS_base {
+    type: string;
+    protected serialize(): string[][];
+    protected deserialize(input: string[][]): void;
+}
+export {};

package/dist/segments/hiccs.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HICCS = exports.HICCSProps = void 0;
+const segment_1 = require("./segment");
+class HICCSProps {
+}
+exports.HICCSProps = HICCSProps;
+/**
+ * HICCS (SEPA credit transfer acknowledgement)
+ */
+class HICCS extends (0, segment_1.SegmentClass)(HICCSProps) {
+    constructor() {
+        super(...arguments);
+        this.type = "HICCS";
+    }
+    serialize() {
+        throw new Error("Not implemented.");
+    }
+    deserialize(input) {
+        if (input.length === 0) {
+            return;
+        }
+        const [[taskId = ""] = []] = input;
+        this.taskId = taskId || undefined;
+    }
+}
+exports.HICCS = HICCS;
+//# sourceMappingURL=hiccs.js.map

package/dist/segments/hiccs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hiccs.js","sourceRoot":"","sources":["../../src/segments/hiccs.ts"],"names":[],"mappings":";;;AAAA,uCAAyC;AAEzC,MAAa,UAAU;CAGtB;AAHD,gCAGC;AAED;;GAEG;AACH,MAAa,KAAM,SAAQ,IAAA,sBAAY,EAAC,UAAU,CAAC;IAAnD;;QACW,SAAI,GAAG,OAAO,CAAC;IAa1B,CAAC;IAXa,SAAS;QACf,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxC,CAAC;IAES,WAAW,CAAC,KAAiB;QACnC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO;QACX,CAAC;QACD,MAAM,CAAC,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,KAAK,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,SAAS,CAAC;IACtC,CAAC;CACJ;AAdD,sBAcC"}

package/dist/segments/hiccss.d.ts

@@ -0,0 +1,13 @@
+export declare class HICCSSProps {
+    segNo: number;
+}
+declare const HICCSS_base: import("..").Constructable<HICCSSProps & import("./segment").Segment<HICCSSProps>>;
+/**
+ * HICCSS (SEPA credit transfer parameters)
+ */
+export declare class HICCSS extends HICCSS_base {
+    type: string;
+    protected serialize(): string[][];
+    protected deserialize(): void;
+}
+export {};

package/dist/segments/hiccss.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HICCSS = exports.HICCSSProps = void 0;
+const segment_1 = require("./segment");
+class HICCSSProps {
+}
+exports.HICCSSProps = HICCSSProps;
+/**
+ * HICCSS (SEPA credit transfer parameters)
+ */
+class HICCSS extends (0, segment_1.SegmentClass)(HICCSSProps) {
+    constructor() {
+        super(...arguments);
+        this.type = "HICCSS";
+    }
+    serialize() {
+        throw new Error("Not implemented.");
+    }
+    deserialize() {
+        return;
+    }
+}
+exports.HICCSS = HICCSS;
+//# sourceMappingURL=hiccss.js.map

package/dist/segments/hiccss.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hiccss.js","sourceRoot":"","sources":["../../src/segments/hiccss.ts"],"names":[],"mappings":";;;AAAA,uCAAyC;AAEzC,MAAa,WAAW;CAEvB;AAFD,kCAEC;AAED;;GAEG;AACH,MAAa,MAAO,SAAQ,IAAA,sBAAY,EAAC,WAAW,CAAC;IAArD;;QACW,SAAI,GAAG,QAAQ,CAAC;IAS3B,CAAC;IAPa,SAAS;QACf,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxC,CAAC;IAES,WAAW;QACjB,OAAO;IACX,CAAC;CACJ;AAVD,wBAUC"}

package/dist/segments/hicdb.d.ts

@@ -0,0 +1,17 @@
+import { StandingOrder } from "../types";
+export declare class HICDBProps {
+    segNo: number;
+    standingOrder: StandingOrder;
+}
+declare const HICDB_base: import("../types").Constructable<HICDBProps & import("./segment").Segment<HICDBProps>>;
+/**
+ * HICDB (SEPA-Dauerauftragsbestand rückmelden)
+ * Section C.10.2.3.4
+ */
+export declare class HICDB extends HICDB_base {
+    type: string;
+    protected serialize(): string[][];
+    protected deserialize(input: string[][]): void;
+    private isDocument;
+}
+export {};