fints-lib 0.6.0 → 0.7.0

package/dist/index.js

@@ -0,0 +1,40 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client"), exports);
+__exportStar(require("./constants"), exports);
+__exportStar(require("./dialog"), exports);
+__exportStar(require("./error-codes"), exports);
+__exportStar(require("./format"), exports);
+__exportStar(require("./http-connection"), exports);
+__exportStar(require("./logger"), exports);
+__exportStar(require("./mt940-86-structured"), exports);
+__exportStar(require("./mt535"), exports);
+__exportStar(require("./pain"), exports);
+__exportStar(require("./pain-formats"), exports);
+__exportStar(require("./parse"), exports);
+__exportStar(require("./pin-tan-client"), exports);
+__exportStar(require("./request"), exports);
+__exportStar(require("./response"), exports);
+__exportStar(require("./return-value"), exports);
+__exportStar(require("./segments"), exports);
+__exportStar(require("./tan-method"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./utils"), exports);
+__exportStar(require("./errors/response-error"), exports);
+__exportStar(require("./errors/tan-required-error"), exports);
+__exportStar(require("./errors/fints-error"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,8CAA4B;AAC5B,2CAAyB;AACzB,gDAA8B;AAC9B,2CAAyB;AACzB,oDAAkC;AAClC,2CAAyB;AACzB,wDAAsC;AACtC,0CAAwB;AACxB,yCAAuB;AACvB,iDAA+B;AAC/B,0CAAwB;AACxB,mDAAiC;AACjC,4CAA0B;AAC1B,6CAA2B;AAC3B,iDAA+B;AAC/B,6CAA2B;AAC3B,+CAA6B;AAC7B,0CAAwB;AACxB,0CAAwB;AACxB,0DAAwC;AACxC,8DAA4C;AAC5C,uDAAqC"}

package/dist/logger.d.ts

@@ -0,0 +1,4 @@
+export declare const logger: import("winston").Logger;
+export declare const verbose: (...args: any[]) => any;
+export declare const warn: (...args: any[]) => any;
+export declare const error: (...args: any[]) => any;

package/dist/logger.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.error = exports.warn = exports.verbose = exports.logger = void 0;
+const winston_1 = require("winston");
+exports.logger = (0, winston_1.createLogger)();
+exports.logger.silent = true;
+const verbose = (...args) => exports.logger.verbose(...args);
+exports.verbose = verbose;
+const warn = (...args) => exports.logger.warn(...args);
+exports.warn = warn;
+const error = (...args) => exports.logger.error(...args);
+exports.error = error;
+//# sourceMappingURL=logger.js.map

package/dist/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";;;AAAA,qCAAuC;AAE1B,QAAA,MAAM,GAAG,IAAA,sBAAY,GAAE,CAAC;AAErC,cAAM,CAAC,MAAM,GAAG,IAAI,CAAC;AAEd,MAAM,OAAO,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE,CAAE,cAAM,CAAC,OAAe,CAAC,GAAG,IAAI,CAAC,CAAC;AAA/D,QAAA,OAAO,WAAwD;AACrE,MAAM,IAAI,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE,CAAE,cAAM,CAAC,IAAY,CAAC,GAAG,IAAI,CAAC,CAAC;AAAzD,QAAA,IAAI,QAAqD;AAC/D,MAAM,KAAK,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE,CAAE,cAAM,CAAC,KAAa,CAAC,GAAG,IAAI,CAAC,CAAC;AAA3D,QAAA,KAAK,SAAsD"}

package/dist/mt535.d.ts

@@ -0,0 +1,19 @@
+import { Holding } from "./types";
+/**
+ * Parser for holdings information encoded in MT535 statements.
+ */
+export declare class MT535Parser {
+    private readonly identification;
+    private readonly marketPrice;
+    private readonly priceDate;
+    private readonly pieces;
+    private readonly totalValue;
+    private readonly acquisitionPrice;
+    parse(lines: string[]): Holding[];
+    private parseFinancialInstrument;
+    private parseClause;
+    private parseDecimal;
+    private parseDate;
+    private collapseMultilines;
+    private grabFinancialInstrumentSegments;
+}

package/dist/mt535.js

@@ -0,0 +1,153 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MT535Parser = void 0;
+/**
+ * Parser for holdings information encoded in MT535 statements.
+ */
+class MT535Parser {
+    constructor() {
+        this.identification = /^:35B:ISIN\s(.*)\|(.*)\|(.*)$/;
+        this.marketPrice = /^:90B::MRKT\/\/ACTU\/([A-Z]{3})(\d*),{1}(\d*)$/;
+        this.priceDate = /^:98A::PRIC\/\/(\d*)$/;
+        this.pieces = /^:93B::AGGR\/\/UNIT\/(\d*),(\d*)$/;
+        this.totalValue = /^:19A::HOLD\/\/([A-Z]{3})(\d*),{1}(\d*)$/;
+        this.acquisitionPrice = /^:70E::HOLD\/\/\d*STK\|2(\d*?),{1}(\d*?)\+([A-Z]{3})$/;
+    }
+    parse(lines) {
+        if (!lines || lines.length === 0) {
+            return [];
+        }
+        const clauses = this.collapseMultilines(lines);
+        const financialInstrumentSegments = this.grabFinancialInstrumentSegments(clauses);
+        return financialInstrumentSegments.reduce((result, segment) => {
+            const holding = this.parseFinancialInstrument(segment);
+            if (holding) {
+                result.push(holding);
+            }
+            return result;
+        }, []);
+    }
+    parseFinancialInstrument(segment) {
+        const context = {};
+        segment.forEach((clause) => this.parseClause(clause, context));
+        if (Object.keys(context).length === 0) {
+            return undefined;
+        }
+        return {
+            isin: context.isin,
+            name: context.name,
+            marketPrice: context.marketPrice,
+            currency: context.currency,
+            valuationDate: context.valuationDate,
+            pieces: context.pieces,
+            totalValue: context.totalValue,
+            acquisitionPrice: context.acquisitionPrice,
+        };
+    }
+    parseClause(clause, context) {
+        let match = this.identification.exec(clause);
+        if (match) {
+            context.isin = match[1];
+            context.name = match[3];
+            return;
+        }
+        match = this.marketPrice.exec(clause);
+        if (match) {
+            context.currency = match[1];
+            context.marketPrice = this.parseDecimal(match[2], match[3]);
+            return;
+        }
+        match = this.priceDate.exec(clause);
+        if (match) {
+            context.valuationDate = this.parseDate(match[1]);
+            return;
+        }
+        match = this.pieces.exec(clause);
+        if (match) {
+            context.pieces = this.parseDecimal(match[1], match[2]);
+            return;
+        }
+        match = this.totalValue.exec(clause);
+        if (match) {
+            context.totalValue = this.parseDecimal(match[2], match[3]);
+            if (!context.currency) {
+                context.currency = match[1];
+            }
+            return;
+        }
+        match = this.acquisitionPrice.exec(clause);
+        if (match) {
+            context.acquisitionPrice = this.parseDecimal(match[1], match[2]);
+        }
+    }
+    parseDecimal(integerPart, fractionPart) {
+        const integer = integerPart || "0";
+        const fraction = fractionPart || "0";
+        return parseFloat(`${integer}.${fraction}`);
+    }
+    parseDate(raw) {
+        if (!raw || raw.length !== 8) {
+            return undefined;
+        }
+        const year = Number(raw.substr(0, 4));
+        const month = Number(raw.substr(4, 2));
+        const day = Number(raw.substr(6, 2));
+        if (Number.isNaN(year) || Number.isNaN(month) || Number.isNaN(day)) {
+            return undefined;
+        }
+        return new Date(Date.UTC(year, month - 1, day));
+    }
+    collapseMultilines(lines) {
+        const clauses = [];
+        let previous = "";
+        for (const line of lines) {
+            if (line.startsWith(":")) {
+                if (previous !== "") {
+                    clauses.push(previous);
+                }
+                previous = line;
+            }
+            else if (line.startsWith("-")) {
+                if (previous !== "") {
+                    clauses.push(previous);
+                }
+                clauses.push(line);
+                previous = "";
+            }
+            else if (previous) {
+                previous += `|${line}`;
+            }
+            else {
+                previous = line;
+            }
+        }
+        if (previous) {
+            clauses.push(previous);
+        }
+        return clauses;
+    }
+    grabFinancialInstrumentSegments(clauses) {
+        const segments = [];
+        let stack = [];
+        let withinInstrument = false;
+        clauses.forEach((clause) => {
+            if (clause.startsWith(":16R:FIN")) {
+                withinInstrument = true;
+                stack = [];
+            }
+            else if (clause.startsWith(":16S:FIN")) {
+                if (withinInstrument) {
+                    segments.push(stack.slice());
+                }
+                withinInstrument = false;
+                stack = [];
+            }
+            else if (withinInstrument) {
+                stack.push(clause);
+            }
+        });
+        return segments;
+    }
+}
+exports.MT535Parser = MT535Parser;
+//# sourceMappingURL=mt535.js.map

package/dist/mt535.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mt535.js","sourceRoot":"","sources":["../src/mt535.ts"],"names":[],"mappings":";;;AAaA;;GAEG;AACH,MAAa,WAAW;IAAxB;QACqB,mBAAc,GAAG,+BAA+B,CAAC;QACjD,gBAAW,GAAG,gDAAgD,CAAC;QAC/D,cAAS,GAAG,uBAAuB,CAAC;QACpC,WAAM,GAAG,mCAAmC,CAAC;QAC7C,eAAU,GAAG,0CAA0C,CAAC;QACxD,qBAAgB,GAAG,uDAAuD,CAAC;IAgJhG,CAAC;IA9IU,KAAK,CAAC,KAAe;QACxB,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,OAAO,EAAE,CAAC;QACd,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,2BAA2B,GAAG,IAAI,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;QAClF,OAAO,2BAA2B,CAAC,MAAM,CAAY,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE;YACrE,MAAM,OAAO,GAAG,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;YACvD,IAAI,OAAO,EAAE,CAAC;gBACV,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACzB,CAAC;YACD,OAAO,MAAM,CAAC;QAClB,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;IAEO,wBAAwB,CAAC,OAAiB;QAC9C,MAAM,OAAO,GAA+B,EAAE,CAAC;QAC/C,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QAC/D,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpC,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO;YACH,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;SAC7C,CAAC;IACN,CAAC;IAEO,WAAW,CAAC,MAAc,EAAE,OAAmC;QACnE,IAAI,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,KAAK,EAAE,CAAC;YACR,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACxB,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACxB,OAAO;QACX,CAAC;QAED,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,KAAK,EAAE,CAAC;YACR,OAAO,CAAC,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAC5B,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5D,OAAO;QACX,CAAC;QAED,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,KAAK,EAAE,CAAC;YACR,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACjD,OAAO;QACX,CAAC;QAED,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,KAAK,EAAE,CAAC;YACR,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACvD,OAAO;QACX,CAAC;QAED,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,KAAK,EAAE,CAAC;YACR,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3D,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACpB,OAAO,CAAC,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAChC,CAAC;YACD,OAAO;QACX,CAAC;QAED,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,KAAK,EAAE,CAAC;YACR,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACrE,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,WAAmB,EAAE,YAAoB;QAC1D,MAAM,OAAO,GAAG,WAAW,IAAI,GAAG,CAAC;QACnC,MAAM,QAAQ,GAAG,YAAY,IAAI,GAAG,CAAC;QACrC,OAAO,UAAU,CAAC,GAAG,OAAO,IAAI,QAAQ,EAAE,CAAC,CAAC;IAChD,CAAC;IAEO,SAAS,CAAC,GAAW;QACzB,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACvC,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACrC,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;YACjE,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IACpD,CAAC;IAEO,kBAAkB,CAAC,KAAe;QACtC,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,IAAI,QAAQ,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvB,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;oBAClB,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC3B,CAAC;gBACD,QAAQ,GAAG,IAAI,CAAC;YACpB,CAAC;iBAAM,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC9B,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;oBAClB,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC3B,CAAC;gBACD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACnB,QAAQ,GAAG,EAAE,CAAC;YAClB,CAAC;iBAAM,IAAI,QAAQ,EAAE,CAAC;gBAClB,QAAQ,IAAI,IAAI,IAAI,EAAE,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACJ,QAAQ,GAAG,IAAI,CAAC;YACpB,CAAC;QACL,CAAC;QACD,IAAI,QAAQ,EAAE,CAAC;YACX,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3B,CAAC;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAEO,+BAA+B,CAAC,OAAiB;QACrD,MAAM,QAAQ,GAAe,EAAE,CAAC;QAChC,IAAI,KAAK,GAAa,EAAE,CAAC;QACzB,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAC7B,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACvB,IAAI,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBAChC,gBAAgB,GAAG,IAAI,CAAC;gBACxB,KAAK,GAAG,EAAE,CAAC;YACf,CAAC;iBAAM,IAAI,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBACvC,IAAI,gBAAgB,EAAE,CAAC;oBACnB,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;gBACjC,CAAC;gBACD,gBAAgB,GAAG,KAAK,CAAC;gBACzB,KAAK,GAAG,EAAE,CAAC;YACf,CAAC;iBAAM,IAAI,gBAAgB,EAAE,CAAC;gBAC1B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACvB,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ;AAtJD,kCAsJC"}

package/dist/mt940-86-structured.d.ts

@@ -0,0 +1,47 @@
+import { Section, PaymentReference, StructuredDescription } from "./types";
+/**
+ * Used to sniff whether the 86 section of the MT940 statement list supports the fints structured
+ * representation.
+ *
+ * @param input The string for the 86 section.
+ *
+ * @return Whether the string is likely structured.
+ */
+export declare function is86Structured(input: string): boolean;
+/**
+ * Parses a commonly used date format ("DATUM 15.11.2018, 12:00 UHR") into a date
+ *
+ * @param content The date string to parse.
+ *
+ * @return The parsed date.
+ */
+export declare function parsePaymentReferenceDate(content: string): Date;
+/**
+ * Parses a commonly format for representing a TAN related to a transaction ("1. TAN 123456").
+ *
+ * @param content The string to parse.
+ *
+ * @return The parsed TAN number and TAN iteself.
+ */
+export declare function parsePaymentReferenceTan(content: string): {
+    num: number;
+    value: string;
+};
+/**
+ * If the payment reference follows the SEPA tagging system, parse the information.
+ * See: https://tinyurl.com/ycdfx5hd
+ *
+ * @param references A list of all sections used for payment reference (20 - 29 and 60 - 63).
+ *
+ * @return A parsed payment reference with all extracted data.
+ */
+export declare function assemblePaymentReference(references: Section[]): PaymentReference;
+/**
+ * Parse as much information as possible from the structured 86 section of a MT940 statement list.
+ * Use `is86Structured` to sniff whether the payment reference is parsable.
+ *
+ * @param input The input string for the 86 section to parse.
+ *
+ * @return The parsed structured description.
+ */
+export declare function parse86Structured(input: string): StructuredDescription;

package/dist/mt940-86-structured.js

@@ -0,0 +1,213 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.is86Structured = is86Structured;
+exports.parsePaymentReferenceDate = parsePaymentReferenceDate;
+exports.parsePaymentReferenceTan = parsePaymentReferenceTan;
+exports.assemblePaymentReference = assemblePaymentReference;
+exports.parse86Structured = parse86Structured;
+const detectionRegex = /(?:^|\?)(..)(.*?)(?:$|\?)/g;
+/**
+ * Used to sniff whether the 86 section of the MT940 statement list supports the fints structured
+ * representation.
+ *
+ * @param input The string for the 86 section.
+ *
+ * @return Whether the string is likely structured.
+ */
+function is86Structured(input) {
+    const matches = [];
+    let lastMatch;
+    do {
+        lastMatch = detectionRegex.exec(input);
+        matches.push(lastMatch);
+    } while (lastMatch);
+    const results = matches
+        .filter((match) => match !== null)
+        .map((match) => ({ code: Number(match[1]), value: match[2] }));
+    if (results.length === 0) {
+        return false;
+    }
+    if (results.some((result) => isNaN(result.code))) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Parses a commonly used date format ("DATUM 15.11.2018, 12:00 UHR") into a date
+ *
+ * @param content The date string to parse.
+ *
+ * @return The parsed date.
+ */
+function parsePaymentReferenceDate(content) {
+    const groups = /DATUM\s+(\d+)\.(\d+)\.(\d+),\s+(\d+)\.(\d+)\s+UHR/.exec(content);
+    if (!groups) {
+        return;
+    }
+    return new Date(Number(groups[3]), Number(groups[2]) - 1, Number(groups[1]), Number(groups[4]), Number(groups[5]));
+}
+/**
+ * Parses a commonly format for representing a TAN related to a transaction ("1. TAN 123456").
+ *
+ * @param content The string to parse.
+ *
+ * @return The parsed TAN number and TAN iteself.
+ */
+function parsePaymentReferenceTan(content) {
+    const groups = /(\d+)\.\s*TAN\s+(.*)/.exec(content);
+    if (!groups) {
+        return;
+    }
+    return {
+        num: Number(groups[1]),
+        value: groups[2],
+    };
+}
+/**
+ * If the payment reference follows the SEPA tagging system, parse the information.
+ * See: https://tinyurl.com/ycdfx5hd
+ *
+ * @param references A list of all sections used for payment reference (20 - 29 and 60 - 63).
+ *
+ * @return A parsed payment reference with all extracted data.
+ */
+function assemblePaymentReference(references) {
+    let lastIdentifiedAttribute;
+    const result = { raw: "" };
+    const add = (name, content) => {
+        lastIdentifiedAttribute = name;
+        result[name] = content;
+    };
+    references
+        .sort((a, b) => a.code - b.code)
+        .forEach(({ content }) => {
+        if (content.startsWith("IBAN+")) {
+            add("iban", content.substr(5));
+        }
+        else if (content.startsWith("BIC+")) {
+            add("bic", content.substr(5));
+        }
+        else if (content.startsWith("EREF+")) {
+            add("endToEndRef", content.substr(5));
+        }
+        else if (content.startsWith("KREF+")) {
+            add("customerRef", content.substr(5));
+        }
+        else if (content.startsWith("MREF+")) {
+            add("mandateRef", content.substr(5));
+        }
+        else if (content.startsWith("CRED+")) {
+            add("creditorId", content.substr(5));
+        }
+        else if (content.startsWith("DEBT+")) {
+            add("originatorId", content.substr(5));
+        }
+        else if (content.startsWith("COAM+")) {
+            add("interestCompensation", content.substr(5));
+        }
+        else if (content.startsWith("OAMT+")) {
+            add("originalTurnover", content.substr(5));
+        }
+        else if (content.startsWith("SVWZ+")) {
+            add("text", content.substr(5));
+        }
+        else if (content.startsWith("ABWA+")) {
+            add("divergingPrincipal", content.substr(5));
+        }
+        else if (content.startsWith("PURP+")) {
+            add("purpose", content.substr(5));
+        }
+        else if (content.startsWith("BREF+")) {
+            add("back", content.substr(5));
+        }
+        else if (content.startsWith("RREF+")) {
+            add("back", content.substr(5));
+        }
+        else if (content.startsWith("DATUM ")) {
+            result.date = parsePaymentReferenceDate(content);
+        }
+        else if (/\d+\.\s*TAN/.test(content)) {
+            result.tan = parsePaymentReferenceTan(content);
+        }
+        else if (lastIdentifiedAttribute) {
+            result[lastIdentifiedAttribute] += content;
+        }
+        result.raw += content;
+        return result;
+    });
+    return result;
+}
+/**
+ * Parse as much information as possible from the structured 86 section of a MT940 statement list.
+ * Use `is86Structured` to sniff whether the payment reference is parsable.
+ *
+ * @param input The input string for the 86 section to parse.
+ *
+ * @return The parsed structured description.
+ */
+function parse86Structured(input) {
+    let iban;
+    let text;
+    let bic;
+    let primaNota;
+    let currentContent = "";
+    let inHeader = true;
+    let sectionCode;
+    const references = [];
+    const names = [];
+    // The header has been parsed fully. Store the section code and begin parsing the content.
+    const flushHeader = () => {
+        sectionCode = Number(currentContent);
+        currentContent = "";
+        inHeader = false;
+    };
+    // A questionmark has been encountered, hence the content of the current section is complete.
+    // Store the parsed data and continue to read the next header.
+    const flushSection = () => {
+        if (sectionCode === 0) {
+            text = currentContent;
+        }
+        else if (sectionCode === 10) {
+            primaNota = currentContent;
+        }
+        else if ((sectionCode >= 20 && sectionCode < 30) || (sectionCode >= 60 && sectionCode <= 63)) {
+            references.push({ code: sectionCode, content: currentContent });
+        }
+        else if (sectionCode === 30) {
+            bic = currentContent;
+        }
+        else if (sectionCode === 31) {
+            iban = currentContent;
+        }
+        else if (sectionCode >= 32 && sectionCode <= 33) {
+            names.push({ code: sectionCode, content: currentContent });
+        }
+        currentContent = "";
+        sectionCode = undefined;
+        inHeader = true;
+    };
+    // Read the string character by character and split it into sections.
+    for (let i = 0; i < input.length; ++i) {
+        const character = input[i];
+        if (character === "?") {
+            flushSection();
+            continue;
+        }
+        currentContent += character;
+        if (inHeader && currentContent.length === 2) {
+            flushHeader();
+            continue;
+        }
+    }
+    // After parsing, flush the last section.
+    flushSection();
+    // The payment reference could have been using tags.
+    // Attempt to parse the tags.
+    const reference = assemblePaymentReference(references);
+    const name = names
+        .sort((a, b) => a.code - b.code)
+        .map((recipient) => recipient.content)
+        .join("");
+    return { reference, name, iban, text, bic, primaNota };
+}
+//# sourceMappingURL=mt940-86-structured.js.map

package/dist/mt940-86-structured.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mt940-86-structured.js","sourceRoot":"","sources":["../src/mt940-86-structured.ts"],"names":[],"mappings":";;AAYA,wCAiBC;AASD,8DAMC;AASD,4DASC;AAUD,4DAiDC;AAUD,8CA2DC;AA5LD,MAAM,cAAc,GAAG,4BAA4B,CAAC;AAEpD;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,KAAa;IACxC,MAAM,OAAO,GAAsB,EAAE,CAAC;IACtC,IAAI,SAA0B,CAAC;IAC/B,GAAG,CAAC;QACA,SAAS,GAAG,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC5B,CAAC,QAAQ,SAAS,EAAE;IACpB,MAAM,OAAO,GAAG,OAAO;SAClB,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC;SACjC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACnE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QAC/C,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,yBAAyB,CAAC,OAAe;IACrD,MAAM,MAAM,GAAG,mDAAmD,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjF,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,OAAO;IACX,CAAC;IACD,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACvH,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,wBAAwB,CAAC,OAAe;IACpD,MAAM,MAAM,GAAG,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpD,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,OAAO;IACX,CAAC;IACD,OAAO;QACH,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACtB,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;KACnB,CAAC;AACN,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,wBAAwB,CAAC,UAAqB;IAC1D,IAAI,uBAAqE,CAAC;IAC1E,MAAM,MAAM,GAAqB,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;IAC7C,MAAM,GAAG,GAAG,CAAC,IAAkD,EAAE,OAAe,EAAE,EAAE;QAChF,uBAAuB,GAAG,IAAI,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;IAC3B,CAAC,CAAC;IACF,UAAU;SACL,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;SAC/B,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;QACrB,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YAC9B,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC;aAAM,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YACpC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAClC,CAAC;aAAM,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC;aAAM,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC;aAAM,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,CAAC;aAAM,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,CAAC;aAAM,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,CAAC;aAAM,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,GAAG,CAAC,sBAAsB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,CAAC;aAAM,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,GAAG,CAAC,kBAAkB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/C,CAAC;aAAM,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC;aAAM,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC;aAAM,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,CAAC;aAAM,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC;aAAM,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC;aAAM,IAAI,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YACtC,MAAM,CAAC,IAAI,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;QACrD,CAAC;aAAM,IAAI,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,MAAM,CAAC,GAAG,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC;QACnD,CAAC;aAAM,IAAI,uBAAuB,EAAE,CAAC;YACjC,MAAM,CAAC,uBAAuB,CAAC,IAAI,OAAO,CAAC;QAC/C,CAAC;QACD,MAAM,CAAC,GAAG,IAAI,OAAO,CAAC;QACtB,OAAO,MAAM,CAAC;IAClB,CAAC,CAAC,CAAC;IACP,OAAO,MAAM,CAAC;AAClB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAAC,KAAa;IAC3C,IAAI,IAAY,CAAC;IACjB,IAAI,IAAY,CAAC;IACjB,IAAI,GAAW,CAAC;IAChB,IAAI,SAAiB,CAAC;IACtB,IAAI,cAAc,GAAG,EAAE,CAAC;IACxB,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,IAAI,WAAmB,CAAC;IACxB,MAAM,UAAU,GAAc,EAAE,CAAC;IACjC,MAAM,KAAK,GAAc,EAAE,CAAC;IAC5B,0FAA0F;IAC1F,MAAM,WAAW,GAAG,GAAG,EAAE;QACrB,WAAW,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;QACrC,cAAc,GAAG,EAAE,CAAC;QACpB,QAAQ,GAAG,KAAK,CAAC;IACrB,CAAC,CAAC;IACF,6FAA6F;IAC7F,8DAA8D;IAC9D,MAAM,YAAY,GAAG,GAAG,EAAE;QACtB,IAAI,WAAW,KAAK,CAAC,EAAE,CAAC;YACpB,IAAI,GAAG,cAAc,CAAC;QAC1B,CAAC;aAAM,IAAI,WAAW,KAAK,EAAE,EAAE,CAAC;YAC5B,SAAS,GAAG,cAAc,CAAC;QAC/B,CAAC;aAAM,IAAI,CAAC,WAAW,IAAI,EAAE,IAAI,WAAW,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,IAAI,WAAW,IAAI,EAAE,CAAC,EAAE,CAAC;YAC7F,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;QACpE,CAAC;aAAM,IAAI,WAAW,KAAK,EAAE,EAAE,CAAC;YAC5B,GAAG,GAAG,cAAc,CAAC;QACzB,CAAC;aAAM,IAAI,WAAW,KAAK,EAAE,EAAE,CAAC;YAC5B,IAAI,GAAG,cAAc,CAAC;QAC1B,CAAC;aAAM,IAAI,WAAW,IAAI,EAAE,IAAI,WAAW,IAAI,EAAE,EAAE,CAAC;YAChD,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;QAC/D,CAAC;QACD,cAAc,GAAG,EAAE,CAAC;QACpB,WAAW,GAAG,SAAS,CAAC;QACxB,QAAQ,GAAG,IAAI,CAAC;IACpB,CAAC,CAAC;IACF,qEAAqE;IACrE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAC3B,IAAI,SAAS,KAAK,GAAG,EAAE,CAAC;YACpB,YAAY,EAAE,CAAC;YACf,SAAS;QACb,CAAC;QACD,cAAc,IAAI,SAAS,CAAC;QAC5B,IAAI,QAAQ,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1C,WAAW,EAAE,CAAC;YACd,SAAS;QACb,CAAC;IACL,CAAC;IACD,yCAAyC;IACzC,YAAY,EAAE,CAAC;IACf,oDAAoD;IACpD,6BAA6B;IAC7B,MAAM,SAAS,GAAG,wBAAwB,CAAC,UAAU,CAAC,CAAC;IACvD,MAAM,IAAI,GAAG,KAAK;SACb,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;SAC/B,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC;SACrC,IAAI,CAAC,EAAE,CAAC,CAAC;IACd,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;AAC3D,CAAC"}

package/dist/pain-formats.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Placeholder definitions for SEPA pain.001.001.03 structures.
+ * The real XSD-derived types are not included in this repository.
+ */
+export interface Pain001Document {
+    Document: {
+        CstmrCdtTrfInitn: CustomerCreditTransferInitiationV03;
+    };
+}
+export interface CustomerCreditTransferInitiationV03 {
+    GrpHdr: {
+        CreDtTm: string;
+        CtrlSum: number;
+    };
+    PmtInf: PaymentInstructionInformationSCT | PaymentInstructionInformationSCT[];
+}
+export interface PaymentInstructionInformationSCT {
+    Dbtr: {
+        Nm: string;
+    };
+    DbtrAcct: {
+        Id: {
+            IBAN: string;
+        };
+    };
+    DbtrAgt: {
+        FinInstnId: {
+            BIC: string;
+        };
+    };
+    CdtTrfTxInf: CreditTransferTransactionInformationSCT | CreditTransferTransactionInformationSCT[];
+}
+export interface CreditTransferTransactionInformationSCT {
+    Cdtr: {
+        Nm: string;
+    };
+    CdtrAcct: {
+        Id: {
+            IBAN: string;
+        };
+    };
+    CdtrAgt: {
+        FinInstnId: {
+            BIC: string;
+        };
+    };
+    RmtInf: {
+        Ustrd: string;
+    };
+}

package/dist/pain-formats.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Placeholder definitions for SEPA pain.001.001.03 structures.
+ * The real XSD-derived types are not included in this repository.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=pain-formats.js.map

package/dist/pain-formats.js.map

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

package/dist/pain.d.ts

@@ -0,0 +1,21 @@
+import { DirectDebitRequest, DirectDebitSubmission, SEPAAccount, CreditTransferRequest, CreditTransferSubmission } from "./types";
+export interface Pain008Message {
+    xml: string;
+    messageId: string;
+    paymentInformationId: string;
+    endToEndId: string;
+    namespace: string;
+}
+export interface Pain001Message {
+    xml: string;
+    messageId: string;
+    paymentInformationId: string;
+    endToEndId: string;
+    namespace: string;
+}
+export declare function selectPain001Descriptor(painFormats: string[]): string;
+export declare function selectPain008Descriptor(painFormats: string[]): string;
+export declare function buildPain008(request: DirectDebitRequest, account: SEPAAccount, descriptor: string): Pain008Message;
+export declare function buildPain001(request: CreditTransferRequest, account: SEPAAccount, descriptor: string): Pain001Message;
+export declare function buildDirectDebitSubmission(request: DirectDebitRequest, account: SEPAAccount, descriptor: string): DirectDebitSubmission;
+export declare function buildCreditTransferSubmission(request: CreditTransferRequest, account: SEPAAccount, descriptor: string): CreditTransferSubmission;