fints-lib 0.6.0 → 0.7.0

package/dist/utils.js

@@ -0,0 +1,178 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeBase64 = encodeBase64;
+exports.decodeBase64 = decodeBase64;
+exports.parse = parse;
+exports.leftPad = leftPad;
+exports.escapeFinTS = escapeFinTS;
+exports.unescapeFinTS = unescapeFinTS;
+const iconv_lite_1 = __importDefault(require("iconv-lite"));
+/**
+ * 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.
+ */
+function encodeBase64(input) {
+    return Buffer.from(iconv_lite_1.default.encode(input, "ISO-8859-1")).toString("base64");
+}
+/**
+ * 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.
+ */
+function decodeBase64(input) {
+    return iconv_lite_1.default.decode(Buffer.from(input, "base64"), "ISO-8859-1");
+}
+/**
+ * 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.
+ */
+function parse(input) {
+    if (input[input.length - 1] !== "'") {
+        throw new Error(`String must end with "'"`);
+    }
+    // Store currently active output.
+    const segments = [];
+    let groups = [];
+    let elements = [];
+    let str = "";
+    // Will be set to `true` if a `?` was encountered, which is used for escaping.
+    let escapeActive = false;
+    // Called when a segment was finished (a `'` was encountered).
+    // Will reset all state and save the current segment to the list of segments.
+    const flushSegment = () => {
+        flushGroup();
+        segments.push(groups);
+        groups = [];
+    };
+    // Called when a data group was finished (a `+` was encountered).
+    // Will reset the group and elements state and save the current group to the list of groups.
+    const flushGroup = () => {
+        flushElement();
+        groups.push(elements);
+        elements = [];
+    };
+    // Called when a data element was finished (a `:` was encountered).
+    // Will reset the string's state and save the current element to the list of elements.
+    const flushElement = () => {
+        elements.push(str);
+        str = "";
+    };
+    // Traverse the input character by character.
+    for (let i = 0; i < input.length; ++i) {
+        const character = input.charAt(i);
+        // If the last character was a questionmark, this character is escaped.
+        if (escapeActive) {
+            if (![":", "'", "+", "?", "@"].includes(character)) {
+                throw new Error(`Unexpected escape sequence "?${character}" at ${i}`);
+            }
+            str += character;
+            escapeActive = false;
+            continue;
+        }
+        // Handle control characters or append default characters to string.
+        switch (character) {
+            case "@":
+                i++;
+                let lengthString = "";
+                for (; i < input.length; ++i) {
+                    const subCharacter = input.charAt(i);
+                    if (subCharacter === "@") {
+                        break;
+                    }
+                    lengthString += subCharacter;
+                }
+                i++;
+                const endIndex = i + Number(lengthString);
+                for (; i < endIndex; ++i) {
+                    str += input.charAt(i);
+                }
+                i--;
+                break;
+            case "?":
+                escapeActive = true;
+                break;
+            case "'":
+                flushSegment();
+                break;
+            case "+":
+                flushGroup();
+                break;
+            case ":":
+                // An ":" was encountered, flush the current group.
+                flushElement();
+                break;
+            default:
+                str += character;
+                break;
+        }
+    }
+    return segments;
+}
+/**
+ * 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.
+ */
+function leftPad(str, count, character = "0") {
+    while (str.length < count) {
+        str = `${character}${str}`;
+    }
+    return str;
+}
+/**
+ * Escape a string into fints representation.
+ *
+ * @param content The string to escape.
+ *
+ * @return The escaped string.
+ */
+function escapeFinTS(content) {
+    if (typeof content === "undefined") {
+        return "";
+    }
+    return content
+        .replace(/\?/g, "??")
+        .replace(/\+/g, "?+")
+        .replace(/:/g, "?:")
+        .replace(/'/g, "?'")
+        .replace(/@/g, "?@");
+}
+/**
+ * Unescape a string from fints representation.
+ *
+ * @param content The string to unescape.
+ *
+ * @return The unescaped string.
+ */
+function unescapeFinTS(content) {
+    if (typeof content === "undefined") {
+        return "";
+    }
+    return content
+        .replace(/\?\?/g, "?")
+        .replace(/\?\+/g, "+")
+        .replace(/\?:/g, ":")
+        .replace(/\?'/g, "'")
+        .replace(/\?@/g, "@");
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;AAUA,oCAEC;AAUD,oCAEC;AAYD,sBAiFC;AAWD,0BAKC;AASD,kCAUC;AASD,sCAUC;AA3KD,4DAA+B;AAE/B;;;;;;;GAOG;AACH,SAAgB,YAAY,CAAC,KAAa;IACtC,OAAO,MAAM,CAAC,IAAI,CAAC,oBAAK,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC7E,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,YAAY,CAAC,KAAa;IACtC,OAAO,oBAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,KAAK,CAAC,KAAa;IAC/B,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAChD,CAAC;IACD,iCAAiC;IACjC,MAAM,QAAQ,GAAiB,EAAE,CAAC;IAClC,IAAI,MAAM,GAAe,EAAE,CAAC;IAC5B,IAAI,QAAQ,GAAa,EAAE,CAAC;IAC5B,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,8EAA8E;IAC9E,IAAI,YAAY,GAAG,KAAK,CAAC;IACzB,8DAA8D;IAC9D,6EAA6E;IAC7E,MAAM,YAAY,GAAG,GAAG,EAAE;QACtB,UAAU,EAAE,CAAC;QACb,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtB,MAAM,GAAG,EAAE,CAAC;IAChB,CAAC,CAAC;IACF,iEAAiE;IACjE,4FAA4F;IAC5F,MAAM,UAAU,GAAG,GAAG,EAAE;QACpB,YAAY,EAAE,CAAC;QACf,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtB,QAAQ,GAAG,EAAE,CAAC;IAClB,CAAC,CAAC;IACF,mEAAmE;IACnE,sFAAsF;IACtF,MAAM,YAAY,GAAG,GAAG,EAAE;QACtB,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,GAAG,GAAG,EAAE,CAAC;IACb,CAAC,CAAC;IACF,6CAA6C;IAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACpC,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAClC,uEAAuE;QACvE,IAAI,YAAY,EAAE,CAAC;YACf,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;gBACjD,MAAM,IAAI,KAAK,CAAC,gCAAgC,SAAS,QAAQ,CAAC,EAAE,CAAC,CAAC;YAC1E,CAAC;YACD,GAAG,IAAI,SAAS,CAAC;YACjB,YAAY,GAAG,KAAK,CAAC;YACrB,SAAS;QACb,CAAC;QACD,oEAAoE;QACpE,QAAQ,SAAS,EAAE,CAAC;YAChB,KAAK,GAAG;gBACJ,CAAC,EAAE,CAAC;gBACJ,IAAI,YAAY,GAAG,EAAE,CAAC;gBACtB,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;oBAC3B,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;oBACrC,IAAI,YAAY,KAAK,GAAG,EAAE,CAAC;wBACvB,MAAM;oBACV,CAAC;oBACD,YAAY,IAAI,YAAY,CAAC;gBACjC,CAAC;gBACD,CAAC,EAAE,CAAC;gBACJ,MAAM,QAAQ,GAAG,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;gBAC1C,OAAO,CAAC,GAAG,QAAQ,EAAE,EAAE,CAAC,EAAE,CAAC;oBACvB,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAC3B,CAAC;gBACD,CAAC,EAAE,CAAC;gBACJ,MAAM;YACV,KAAK,GAAG;gBACJ,YAAY,GAAG,IAAI,CAAC;gBACpB,MAAM;YACV,KAAK,GAAG;gBACJ,YAAY,EAAE,CAAC;gBACf,MAAM;YACV,KAAK,GAAG;gBACJ,UAAU,EAAE,CAAC;gBACb,MAAM;YACV,KAAK,GAAG;gBACJ,mDAAmD;gBACnD,YAAY,EAAE,CAAC;gBACf,MAAM;YACV;gBACI,GAAG,IAAI,SAAS,CAAC;gBACjB,MAAM;QACd,CAAC;IACL,CAAC;IACD,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,OAAO,CAAC,GAAW,EAAE,KAAa,EAAE,SAAS,GAAG,GAAG;IAC/D,OAAO,GAAG,CAAC,MAAM,GAAG,KAAK,EAAE,CAAC;QACxB,GAAG,GAAG,GAAG,SAAS,GAAG,GAAG,EAAE,CAAC;IAC/B,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,OAAe;IACvC,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE,CAAC;QACjC,OAAO,EAAE,CAAC;IACd,CAAC;IACD,OAAO,OAAO;SACT,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC;SACpB,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC;SACpB,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC;SACnB,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC;SACnB,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,aAAa,CAAC,OAAe;IACzC,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE,CAAC;QACjC,OAAO,EAAE,CAAC;IACd,CAAC;IACD,OAAO,OAAO;SACT,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SACpB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SACpB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC9B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fints-lib",
-    "version": "0.6.0",
+    "version": "0.7.0",
     "description": "FinTS client library with psd2 support",
     "keywords": [
         "fints",