fints-lib 0.6.0 → 0.7.0

package/dist/tan-method.js

@@ -0,0 +1,224 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TanMethod = exports.tanMethodArgumentMap = void 0;
+const parse_1 = require("./parse");
+exports.tanMethodArgumentMap = new Map();
+exports.tanMethodArgumentMap.set(1, [
+    "securityFunction",
+    "tanProcess",
+    "techId",
+    "name",
+    "maxLengthInput",
+    "allowedFormat",
+    "textReturnvalue",
+    "maxLengthReturnvalue",
+    "numberOfSupportedLists",
+    "multiple",
+    "tanTimeDialogAssociation",
+]);
+exports.tanMethodArgumentMap.set(2, [
+    "securityFunction",
+    "tanProcess",
+    "techId",
+    "name",
+    "maxLengthInput",
+    "allowedFormat",
+    "textReturnvalue",
+    "maxLengthReturnvalue",
+    "numberOfSupportedLists",
+    "multiple",
+    "tanTimeDialogAssociation",
+    "tanListNumberRequired",
+    "cancellable",
+    "challengeClassRequired",
+    "challengeValueRequired",
+]);
+exports.tanMethodArgumentMap.set(3, [
+    "securityFunction",
+    "tanProcess",
+    "techId",
+    "name",
+    "maxLengthInput",
+    "allowedFormat",
+    "textReturnvalue",
+    "maxLengthReturnvalue",
+    "numberOfSupportedLists",
+    "multiple",
+    "tanTimeDialogAssociation",
+    "tanListNumberRequired",
+    "cancellable",
+    "challengeClassRequired",
+    "challengeValueRequired",
+    "initializationMode",
+    "descriptionRequired",
+    "supportedMediaNumber",
+]);
+exports.tanMethodArgumentMap.set(4, [
+    "securityFunction",
+    "tanProcess",
+    "techId",
+    "zkaId",
+    "zkaVersion",
+    "name",
+    "maxLengthInput",
+    "allowedFormat",
+    "textReturnvalue",
+    "maxLengthReturnvalue",
+    "numberOfSupportedLists",
+    "multiple",
+    "tanTimeDialogAssociation",
+    "tanListNumberRequired",
+    "cancellable",
+    "smsChargeAccountRequired",
+    "challengeClassRequired",
+    "challengeValueRequired",
+    "challengeStructured",
+    "initializationMode",
+    "descriptionRequired",
+    "supportedMediaNumber",
+]);
+exports.tanMethodArgumentMap.set(5, [
+    "securityFunction",
+    "tanProcess",
+    "techId",
+    "zkaId",
+    "zkaVersion",
+    "name",
+    "maxLengthInput",
+    "allowedFormat",
+    "textReturnvalue",
+    "maxLengthReturnvalue",
+    "numberOfSupportedLists",
+    "multiple",
+    "tanTimeDialogAssociation",
+    "tanListNumberRequired",
+    "cancellable",
+    "smsChargeAccountRequired",
+    "principalAccountRequired",
+    "challengeClassRequired",
+    "challengeValueRequired",
+    "initializationMode",
+    "descriptionRequired",
+    "supportedMediaNumber",
+]);
+exports.tanMethodArgumentMap.set(6, [
+    "securityFunction",
+    "tanProcess",
+    "techId",
+    "zkaId",
+    "zkaVersion",
+    "name",
+    "maxLengthInput",
+    "allowedFormat",
+    "textReturnvalue",
+    "maxLengthReturnvalue",
+    "multiple",
+    "tanTimeDialogAssociation",
+    "cancellable",
+    "smsChargeAccountRequired",
+    "principalAccountRequired",
+    "challengeClassRequired",
+    "challengeStructured",
+    "initializationMode",
+    "descriptionRequired",
+    "hhdUcRequired",
+    "supportedMediaNumber",
+]);
+exports.tanMethodArgumentMap.set(7, [
+    "securityFunction",
+    "tanProcess",
+    "techId",
+    "zkaId",
+    "zkaVersion",
+    "name",
+    "maxLengthInput",
+    "allowedFormat",
+    "textReturnvalue",
+    "maxLengthReturnvalue",
+    "numberOfSupportedLists",
+    "multiple",
+    "tanTimeDialogAssociation",
+    "tanDialogOptions",
+    "tanListNumberRequired",
+    "cancellable",
+    "smsChargeAccountRequired",
+    "principalAccountRequired",
+    "challengeClassRequired",
+    "challengeValueRequired",
+    "challengeStructured",
+    "initializationMode",
+    "supportedMediaNumber",
+    "hhdUcRequired",
+    "activeTanMedia",
+    "decoupledMaxStatusRequests",
+    "decoupledWaitBeforeFirstStatusRequest",
+    "decoupledWaitBetweenStatusRequests",
+    "decoupledManualConfirmationAllowed",
+    "decoupledAutoConfirmationAllowed",
+]);
+class TanMethod {
+    constructor(version, config) {
+        this.version = version;
+        const argumentList = exports.tanMethodArgumentMap.get(version) || [];
+        const map = argumentList.reduce((result, argumentName, index) => {
+            if (config && typeof config[index] !== "undefined") {
+                result.set(argumentName, config[index]);
+            }
+            return result;
+        }, new Map());
+        this.allowedFormat = map.get("allowedFormat");
+        this.cancellable = parse_1.Parse.bool(map.get("cancellable"));
+        this.challengeClassRequired = parse_1.Parse.bool(map.get("challengeClassRequired"));
+        this.challengeValueRequired = parse_1.Parse.bool(map.get("challengeValueRequired"));
+        this.challengeStructured = parse_1.Parse.bool(map.get("challengeStructured"));
+        const decoupledAuto = map.get("decoupledAutoConfirmationAllowed");
+        if (typeof decoupledAuto !== "undefined") {
+            this.decoupledAutoConfirmationAllowed = parse_1.Parse.bool(decoupledAuto);
+        }
+        const decoupledManual = map.get("decoupledManualConfirmationAllowed");
+        if (typeof decoupledManual !== "undefined") {
+            this.decoupledManualConfirmationAllowed = parse_1.Parse.bool(decoupledManual);
+        }
+        const decoupledMax = map.get("decoupledMaxStatusRequests");
+        if (typeof decoupledMax !== "undefined") {
+            this.decoupledMaxStatusRequests = parse_1.Parse.num(decoupledMax);
+        }
+        const decoupledWaitFirst = map.get("decoupledWaitBeforeFirstStatusRequest");
+        if (typeof decoupledWaitFirst !== "undefined") {
+            this.decoupledWaitBeforeFirstStatusRequest = parse_1.Parse.num(decoupledWaitFirst);
+        }
+        const decoupledWaitBetween = map.get("decoupledWaitBetweenStatusRequests");
+        if (typeof decoupledWaitBetween !== "undefined") {
+            this.decoupledWaitBetweenStatusRequests = parse_1.Parse.num(decoupledWaitBetween);
+        }
+        this.descriptionRequired = map.get("descriptionRequired");
+        this.hhdUcRequired = parse_1.Parse.bool(map.get("hhdUcRequired"));
+        this.initializationMode = map.get("initializationMode");
+        this.maxLengthInput = parse_1.Parse.num(map.get("maxLengthInput"));
+        this.maxLengthReturnvalue = parse_1.Parse.num(map.get("maxLengthReturnvalue"));
+        this.multiple = parse_1.Parse.bool(map.get("multiple"));
+        this.name = map.get("name");
+        const activeTanMedia = map.get("activeTanMedia");
+        if (typeof activeTanMedia !== "undefined") {
+            this.activeTanMedia = parse_1.Parse.num(activeTanMedia);
+        }
+        this.numberOfSupportedLists = parse_1.Parse.num(map.get("numberOfSupportedLists"));
+        this.principalAccountRequired = map.get("principalAccountRequired") === "2";
+        this.securityFunction = map.get("securityFunction");
+        this.smsChargeAccountRequired = map.get("smsChargeAccountRequired") === "1";
+        this.supportedMediaNumber = parse_1.Parse.num(map.get("supportedMediaNumber"));
+        this.tanListNumberRequired = parse_1.Parse.bool(map.get("tanListNumberRequired"));
+        this.tanProcess = map.get("tanProcess");
+        const tanDialogOptions = map.get("tanDialogOptions");
+        if (typeof tanDialogOptions !== "undefined") {
+            this.tanDialogOptions = tanDialogOptions;
+        }
+        this.tanTimeDialogAssociation = map.get("tanTimeDialogAssociation");
+        this.techId = map.get("techId");
+        this.textReturnvalue = map.get("textReturnvalue");
+        this.zkaId = map.get("zkaId");
+        this.zkaVersion = map.get("zkaVersion");
+    }
+}
+exports.TanMethod = TanMethod;
+//# sourceMappingURL=tan-method.js.map

package/dist/tan-method.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tan-method.js","sourceRoot":"","sources":["../src/tan-method.ts"],"names":[],"mappings":";;;AAAA,mCAAgC;AAEnB,QAAA,oBAAoB,GAAG,IAAI,GAAG,EAAoB,CAAC;AAEhE,4BAAoB,CAAC,GAAG,CAAC,CAAC,EAAE;IACxB,kBAAkB;IAClB,YAAY;IACZ,QAAQ;IACR,MAAM;IACN,gBAAgB;IAChB,eAAe;IACf,iBAAiB;IACjB,sBAAsB;IACtB,wBAAwB;IACxB,UAAU;IACV,0BAA0B;CAC7B,CAAC,CAAC;AAEH,4BAAoB,CAAC,GAAG,CAAC,CAAC,EAAE;IACxB,kBAAkB;IAClB,YAAY;IACZ,QAAQ;IACR,MAAM;IACN,gBAAgB;IAChB,eAAe;IACf,iBAAiB;IACjB,sBAAsB;IACtB,wBAAwB;IACxB,UAAU;IACV,0BAA0B;IAC1B,uBAAuB;IACvB,aAAa;IACb,wBAAwB;IACxB,wBAAwB;CAC3B,CAAC,CAAC;AAEH,4BAAoB,CAAC,GAAG,CAAC,CAAC,EAAE;IACxB,kBAAkB;IAClB,YAAY;IACZ,QAAQ;IACR,MAAM;IACN,gBAAgB;IAChB,eAAe;IACf,iBAAiB;IACjB,sBAAsB;IACtB,wBAAwB;IACxB,UAAU;IACV,0BAA0B;IAC1B,uBAAuB;IACvB,aAAa;IACb,wBAAwB;IACxB,wBAAwB;IACxB,oBAAoB;IACpB,qBAAqB;IACrB,sBAAsB;CACzB,CAAC,CAAC;AAEH,4BAAoB,CAAC,GAAG,CAAC,CAAC,EAAE;IACxB,kBAAkB;IAClB,YAAY;IACZ,QAAQ;IACR,OAAO;IACP,YAAY;IACZ,MAAM;IACN,gBAAgB;IAChB,eAAe;IACf,iBAAiB;IACjB,sBAAsB;IACtB,wBAAwB;IACxB,UAAU;IACV,0BAA0B;IAC1B,uBAAuB;IACvB,aAAa;IACb,0BAA0B;IAC1B,wBAAwB;IACxB,wBAAwB;IACxB,qBAAqB;IACrB,oBAAoB;IACpB,qBAAqB;IACrB,sBAAsB;CACzB,CAAC,CAAC;AAEH,4BAAoB,CAAC,GAAG,CAAC,CAAC,EAAE;IACxB,kBAAkB;IAClB,YAAY;IACZ,QAAQ;IACR,OAAO;IACP,YAAY;IACZ,MAAM;IACN,gBAAgB;IAChB,eAAe;IACf,iBAAiB;IACjB,sBAAsB;IACtB,wBAAwB;IACxB,UAAU;IACV,0BAA0B;IAC1B,uBAAuB;IACvB,aAAa;IACb,0BAA0B;IAC1B,0BAA0B;IAC1B,wBAAwB;IACxB,wBAAwB;IACxB,oBAAoB;IACpB,qBAAqB;IACrB,sBAAsB;CACzB,CAAC,CAAC;AAEH,4BAAoB,CAAC,GAAG,CAAC,CAAC,EAAE;IACxB,kBAAkB;IAClB,YAAY;IACZ,QAAQ;IACR,OAAO;IACP,YAAY;IACZ,MAAM;IACN,gBAAgB;IAChB,eAAe;IACf,iBAAiB;IACjB,sBAAsB;IACtB,UAAU;IACV,0BAA0B;IAC1B,aAAa;IACb,0BAA0B;IAC1B,0BAA0B;IAC1B,wBAAwB;IACxB,qBAAqB;IACrB,oBAAoB;IACpB,qBAAqB;IACrB,eAAe;IACf,sBAAsB;CACzB,CAAC,CAAC;AAEH,4BAAoB,CAAC,GAAG,CAAC,CAAC,EAAE;IACxB,kBAAkB;IAClB,YAAY;IACZ,QAAQ;IACR,OAAO;IACP,YAAY;IACZ,MAAM;IACN,gBAAgB;IAChB,eAAe;IACf,iBAAiB;IACjB,sBAAsB;IACtB,wBAAwB;IACxB,UAAU;IACV,0BAA0B;IAC1B,kBAAkB;IAClB,uBAAuB;IACvB,aAAa;IACb,0BAA0B;IAC1B,0BAA0B;IAC1B,wBAAwB;IACxB,wBAAwB;IACxB,qBAAqB;IACrB,oBAAoB;IACpB,sBAAsB;IACtB,eAAe;IACf,gBAAgB;IAChB,4BAA4B;IAC5B,uCAAuC;IACvC,oCAAoC;IACpC,oCAAoC;IACpC,kCAAkC;CACrC,CAAC,CAAC;AAEH,MAAa,SAAS;IAkClB,YAAY,OAAe,EAAE,MAAiB;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,MAAM,YAAY,GAAG,4BAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAC7D,MAAM,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,EAAE;YAC5D,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,WAAW,EAAE,CAAC;gBACjD,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC5C,CAAC;YACD,OAAO,MAAM,CAAC;QAClB,CAAC,EAAE,IAAI,GAAG,EAAkB,CAAC,CAAC;QAC9B,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC9C,IAAI,CAAC,WAAW,GAAG,aAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;QACtD,IAAI,CAAC,sBAAsB,GAAG,aAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC,CAAC;QAC5E,IAAI,CAAC,sBAAsB,GAAG,aAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC,CAAC;QAC5E,IAAI,CAAC,mBAAmB,GAAG,aAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC;QACtE,MAAM,aAAa,GAAG,GAAG,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;QAClE,IAAI,OAAO,aAAa,KAAK,WAAW,EAAE,CAAC;YACvC,IAAI,CAAC,gCAAgC,GAAG,aAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACtE,CAAC;QACD,MAAM,eAAe,GAAG,GAAG,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;QACtE,IAAI,OAAO,eAAe,KAAK,WAAW,EAAE,CAAC;YACzC,IAAI,CAAC,kCAAkC,GAAG,aAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC1E,CAAC;QACD,MAAM,YAAY,GAAG,GAAG,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;QAC3D,IAAI,OAAO,YAAY,KAAK,WAAW,EAAE,CAAC;YACtC,IAAI,CAAC,0BAA0B,GAAG,aAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAC9D,CAAC;QACD,MAAM,kBAAkB,GAAG,GAAG,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;QAC5E,IAAI,OAAO,kBAAkB,KAAK,WAAW,EAAE,CAAC;YAC5C,IAAI,CAAC,qCAAqC,GAAG,aAAK,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QAC/E,CAAC;QACD,MAAM,oBAAoB,GAAG,GAAG,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;QAC3E,IAAI,OAAO,oBAAoB,KAAK,WAAW,EAAE,CAAC;YAC9C,IAAI,CAAC,kCAAkC,GAAG,aAAK,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAC9E,CAAC;QACD,IAAI,CAAC,mBAAmB,GAAG,GAAG,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QAC1D,IAAI,CAAC,aAAa,GAAG,aAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC;QAC1D,IAAI,CAAC,kBAAkB,GAAG,GAAG,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QACxD,IAAI,CAAC,cAAc,GAAG,aAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAC3D,IAAI,CAAC,oBAAoB,GAAG,aAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,QAAQ,GAAG,aAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC5B,MAAM,cAAc,GAAG,GAAG,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACjD,IAAI,OAAO,cAAc,KAAK,WAAW,EAAE,CAAC;YACxC,IAAI,CAAC,cAAc,GAAG,aAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,CAAC,sBAAsB,GAAG,aAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC,CAAC;QAC3E,IAAI,CAAC,wBAAwB,GAAG,GAAG,CAAC,GAAG,CAAC,0BAA0B,CAAC,KAAK,GAAG,CAAC;QAC5E,IAAI,CAAC,gBAAgB,GAAG,GAAG,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QACpD,IAAI,CAAC,wBAAwB,GAAG,GAAG,CAAC,GAAG,CAAC,0BAA0B,CAAC,KAAK,GAAG,CAAC;QAC5E,IAAI,CAAC,oBAAoB,GAAG,aAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,qBAAqB,GAAG,aAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACxC,MAAM,gBAAgB,GAAG,GAAG,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QACrD,IAAI,OAAO,gBAAgB,KAAK,WAAW,EAAE,CAAC;YAC1C,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,wBAAwB,GAAG,GAAG,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;QACpE,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAChC,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAClD,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC5C,CAAC;CACJ;AAhGD,8BAgGC"}

package/dist/types.d.ts

@@ -0,0 +1,386 @@
+import { Statement as MT940Statement, Transaction as MT940Transaction } from "mt940-js";
+import { Request } from "./request";
+import { Response } from "./response";
+export interface Constructable<T> {
+    new (...args: any[]): T;
+}
+/**
+ * A payment reference as wrapped in a structured description in the 86 section of the MT 940 format.
+ * Most properties will likely be `undefined` if no matching tags were found.
+ */
+export interface PaymentReference {
+    /**
+     * The unprocessed, raw payment reference as a string.
+     */
+    raw: string;
+    /**
+     * The principal's IBAN (IBAN+ tag).
+     */
+    iban?: string;
+    /**
+     * The principal's BIC (BIC+ tag).
+     */
+    bic?: string;
+    /**
+     * End to end reference of the transaction (EREF+ tag).
+     */
+    endToEndRef?: string;
+    /**
+     * Customer reference (KREF+).
+     */
+    customerRef?: string;
+    /**
+     * Mandate reference (MREF+). Specified if the transaction was a debit.
+     */
+    mandateRef?: string;
+    /**
+     * Creditor identification (CRED+). Specified if the transaction was a debit.
+     */
+    creditorId?: string;
+    /**
+     * Original amount of turnover (OAMT+). Specified if the transaction was a return.
+     */
+    originalTurnover?: string;
+    /**
+     * Interest compensation (COAM+). Specified if the transaction was a return.
+     */
+    interestCompensation?: string;
+    /**
+     * Specified if the principal of the transaction was diverging (ABWA+).
+     */
+    divergingPrincipal?: string;
+    /**
+     * Bank identification reference (BREF+).
+     */
+    bank?: string;
+    /**
+     * Return reference (RREF+). Specified if the transaction was a return.
+     */
+    back?: string;
+    /**
+     * The originator's id (DEBT+).
+     */
+    originatorId?: string;
+    /**
+     * The transaction's date (DATUM).
+     */
+    date?: Date;
+    /**
+     * The tan associated with the transaction (TAN).
+     */
+    tan?: {
+        num: number;
+        value: string;
+    };
+    /**
+     * The principal's specified payment reference (description text of the transaction) (SVWZ+).
+     */
+    text?: string;
+    /** Purpose code */
+    purpose?: string;
+}
+/**
+ * A parsed structure from the description in the 86 section of a MT940 list of s
+ */
+export interface StructuredDescription {
+    /**
+     * Payment reference. Can be a parsed structure using tags or only contain the textual representation in the
+     * property named `raw`.
+     */
+    reference: PaymentReference;
+    /**
+     * The name of the principal or benefitiary.
+     */
+    name: string;
+    /**
+     * The IBAN of the principal or benefitiary.
+     */
+    iban: string;
+    /**
+     * The textual, not parsed representation of the description.
+     */
+    text: string;
+    /**
+     * The BIC of the principal or benefitiary.
+     */
+    bic: string;
+    /**
+     * The prima nota associated with this transaction.
+     * Used by some german banks. See: https://de.wikipedia.org/wiki/Primanota
+     */
+    primaNota: string;
+}
+/**
+ * An unparsed raw sub section from the structured 86 section.
+ */
+export interface Section {
+    /**
+     * The section's code.
+     */
+    code: number;
+    /**
+     * The section's raw content.
+     */
+    content: string;
+}
+/**
+ * A single SEPA account.
+ */
+export interface SEPAAccount {
+    /**
+     * The account's IBAN.
+     */
+    iban: string;
+    /**
+     * The account's BIC.
+     */
+    bic: string;
+    /**
+     * The account's internal account number used together with the BLZ before SEPA.
+     */
+    accountNumber: string;
+    /**
+     * An optional sub account identification.
+     */
+    subAccount?: string;
+    /**
+     * The account's BLZ used together with the account number before SEPA.
+     */
+    blz: string;
+    /**
+     * Name of the account owner if known
+     */
+    accountOwnerName?: string;
+    accountName?: string;
+    limitValue?: number;
+}
+/**
+ * A single SEPA account.
+ */
+export interface SEPAAccountHiupd {
+    accountNumber: string;
+    iban: string;
+    accountOwnerName1: string;
+    accountName: string;
+    limitValue: string;
+}
+/**
+ * A single standing order.
+ */
+export interface StandingOrder {
+    /**
+     * The next time this standing order will trigger a transaction.
+     */
+    nextOrderDate: Date;
+    /**
+     * Unit of the order-interval.
+     */
+    timeUnit: string;
+    /**
+     * Interval of repeating transactions.
+     */
+    interval: number;
+    /**
+     * Day in month when transaction is triggered.
+     */
+    orderDay?: number;
+    /**
+     * The last time this standing order will trigger a transaction.
+     */
+    lastOrderDate?: Date;
+    /**
+     * Creation date of this standing order.
+     */
+    creationDate: Date;
+    /**
+     * The debitor.
+     */
+    debitor: PartyIdentification;
+    /**
+     * The creditor.
+     */
+    creditor: PartyIdentification;
+    /**
+     * The amount of every transaction.
+     */
+    amount: number;
+    /**
+     * The payment purpose (text of the transaction).
+     */
+    paymentPurpose: string;
+}
+export type DirectDebitScheme = "CORE" | "B2B" | "COR1";
+export type DirectDebitSequenceType = "OOFF" | "FRST" | "RCUR" | "FNAL";
+export interface DirectDebitParty {
+    name: string;
+    iban: string;
+    bic?: string;
+}
+export interface DirectDebitRequest {
+    creditorName: string;
+    creditorId: string;
+    debtor: DirectDebitParty;
+    amount: number;
+    currency?: string;
+    endToEndId?: string;
+    remittanceInformation?: string;
+    purposeCode?: string;
+    mandateId: string;
+    mandateSignatureDate: Date;
+    requestedCollectionDate: Date;
+    sequenceType?: DirectDebitSequenceType;
+    localInstrument?: DirectDebitScheme;
+    batchBooking?: boolean;
+    messageId?: string;
+    paymentInformationId?: string;
+    creationDateTime?: Date;
+}
+export interface DirectDebitSubmission {
+    taskId?: string;
+    messageId: string;
+    paymentInformationId: string;
+    endToEndId: string;
+    painDescriptor: string;
+    xml: string;
+}
+export interface CreditTransferParty {
+    name: string;
+    iban: string;
+    bic?: string;
+}
+export interface CreditTransferRequest {
+    debtorName: string;
+    creditor: CreditTransferParty;
+    amount: number;
+    currency?: string;
+    endToEndId?: string;
+    remittanceInformation?: string;
+    purposeCode?: string;
+    executionDate?: Date;
+    batchBooking?: boolean;
+    messageId?: string;
+    paymentInformationId?: string;
+    creationDateTime?: Date;
+}
+export interface CreditTransferSubmission {
+    taskId?: string;
+    messageId: string;
+    paymentInformationId: string;
+    endToEndId: string;
+    painDescriptor: string;
+    xml: string;
+}
+/**
+ * Represents a creditor or debitor identification object.
+ */
+export interface PartyIdentification {
+    /**
+     * Name of the party.
+     */
+    name: string;
+    /**
+     * IBAN of the party.
+     */
+    iban: string;
+    /**
+     * BIC of the party.
+     */
+    bic: string;
+}
+/**
+ * An augmented version of the `mt940-js` `Transaction` with an added parsed
+ * version of structured 86 fields.
+ */
+export interface Transaction extends MT940Transaction {
+    descriptionStructured?: StructuredDescription;
+}
+/**
+ * An augmented version of the `mt940-js` `Statement` with an added parsed
+ * version of structured 86 fields on each transaction.
+ */
+export interface Statement extends MT940Statement {
+    transactions: Transaction[];
+}
+/**
+ * Represents the balance for a single SEPA account.
+ */
+export interface Balance {
+    /**
+     * The SEPA account, this balance belongs to.
+     */
+    account: SEPAAccount;
+    /**
+     * The product name of this account.
+     */
+    productName: string;
+    /**
+     * The currency of this account.
+     */
+    currency: string;
+    /**
+     * Balance which is already booked of this account.
+     */
+    bookedBalance: number;
+    /**
+     * Balance of pending transactions of this account.
+     */
+    pendingBalance: number;
+    /**
+     * Available credit limit of this account.
+     */
+    creditLimit: number;
+    /**
+     * Balance which is accessible for this account.
+     */
+    availableBalance: number;
+}
+/**
+ * Represents a single security or holding entry returned by the bank.
+ */
+export interface Holding {
+    /**
+     * International Securities Identification Number of the holding.
+     */
+    isin?: string;
+    /**
+     * Human readable name of the holding.
+     */
+    name?: string;
+    /**
+     * Latest market price transmitted by the bank.
+     */
+    marketPrice?: number;
+    /**
+     * Currency in which all monetary values are denominated.
+     */
+    currency?: string;
+    /**
+     * Date of the valuation.
+     */
+    valuationDate?: Date;
+    /**
+     * Number of units held.
+     */
+    pieces?: number;
+    /**
+     * Total value of the position.
+     */
+    totalValue?: number;
+    /**
+     * Acquisition price communicated by the institute.
+     */
+    acquisitionPrice?: number;
+}
+/**
+ * A connection used in the client to contact the server.
+ */
+export interface Connection {
+    /**
+     * Send a request to the server and return the response received.
+     *
+     * @param request Request to send to the server.
+     *
+     * @return The response received from the server.
+     */
+    send(request: Request): Promise<Response>;
+}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/dist/utils.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Base 64 encode a string for use with fints. Fints uses ISO-8859-1 encoding which will be the encoding used
+ * in the base 64 data.
+ *
+ * @param input The string to encode.
+ *
+ * @return The encoded string.
+ */
+export declare function encodeBase64(input: string): string;
+/**
+ * Decode a base 64 encoded string received from a fints server.
+ * Fints uses ISO-8859-1 encoding which will be converted into UTF-8.
+ *
+ * @param input The string to decode.
+ *
+ * @return The decoded string.
+ */
+export declare function decodeBase64(input: string): string;
+/**
+ * Parse a full fints message into a set of segments containing a set of data groups containing a set of
+ * data elements.
+ * Can be parsed further by using segment classes.
+ * Bit strings with length will be resolved here.
+ *
+ * @param input The string to parse.
+ *
+ * @return Set of segments.
+ */
+export declare function parse(input: string): string[][][];
+/**
+ * Fill up the string with the specified character from the left.
+ *
+ * @param str String to pad.
+ * @param count Limit to which the string should be padded.
+ * @param character Character to pad the string with. Defaults to "0".
+ *
+ * @return The padded string.
+ */
+export declare function leftPad(str: string, count: number, character?: string): string;
+/**
+ * Escape a string into fints representation.
+ *
+ * @param content The string to escape.
+ *
+ * @return The escaped string.
+ */
+export declare function escapeFinTS(content: string): string;
+/**
+ * Unescape a string from fints representation.
+ *
+ * @param content The string to unescape.
+ *
+ * @return The unescaped string.
+ */
+export declare function unescapeFinTS(content: string): string;