bysquare 1.0.8 → 1.1.0

package/README.md

@@ -17,6 +17,10 @@ other payment regulations.
 This library is un-opinionated. Image generation from qr-code string depends on
 your implementation. See [examples](examples).
 
+## How it works
+
+![diagram](./uml/logic.svg)
+
 ## Install
 
 Node.js
@@ -33,12 +37,10 @@ npm install --global bysquare
 
 ## API
 
-### `function generate(model: Model): Promise<string>`
-
-**Example (TypeScript)**
+### **generate(model: Model): Promise<string>**
 
 ```typescript
-import { generate, Model } from "bysquare";
+import { generate, parse, Model } from "bysquare";
 
 const model: Model = {
     IBAN: "SK9611000000002918599669",
@@ -50,40 +52,28 @@ const model: Model = {
     BankAccounts: 1,
 };
 
-generate(model).then((qrString) => {
+generate(model).then((qrString: string) => {
+    // "0004G0005ES17OQ09C98Q7ME34TCR3V71LVKD2AE6EGHKR82DKS5NBJ3331VUFQIV0JGMR743UJCKSAKEM9QGVVVOIVH000"
     // your logic...
 });
 ```
 
-### `function parse(qrString: string): Promise<Model>`
-
-**Example (TypeScript)**
+### **parse(qrString: string): Promise<Model>**
 
 ```typescript
-import { parse } from "bysquare";
-
-const generated = "0004G0005ES17OQ09C98Q7ME34TCR3V71LVKD2AE6EGHKR82DKS5NBJ3331VUFQIV0JGMR743UJCKSAKEM9QGVVVOIVH000";
-
-parse(generated).then((model) => {
-    console.log(model);
-    // {
-    //     IBAN: 'SK9611000000002918599669',
-    //     Amount: 100.0,
-    //     CurrencyCode: "EUR",
-    //     VariableSymbol: "123",
-    //     Payments: 1,
-    //     PaymentOptions: 1,
-    //     BankAccounts: 1,
-    // };
+import { parse, Model } from "bysquare";
+
+const qrString = "0004G0005ES17OQ09C98Q7ME34TCR3V71LVKD2AE6EGHKR82DKS5NBJ3331VUFQIV0JGMR743UJCKSAKEM9QGVVVOIVH000"
+
+parse(qrString).then((model: Model) => {
+    // your logic...
 });
 ```
 
-### CLI
+## CLI
 
 You can use json file with valid model to generate qr-string.
 
-**Example**
-
 ```sh
 # example.json
 # {
@@ -102,8 +92,6 @@ You can use json file with valid model to generate qr-string.
 
 You can also use stdin.
 
-**Example**
-
 ```sh
 > echo '
     {
@@ -158,10 +146,6 @@ You can also use stdin.
 | BeneficiaryAddressLine1          | `string` | no       |
 | BeneficiaryAddressLine2          | `string` | no       |
 
-## How it works
-
-![diagram](./uml/logic.svg)
-
 ## Resources
 
 - <https://bysquare.com/>

package/lib/cli.js

@@ -41,11 +41,12 @@ var fs_1 = require("fs");
 var readline_1 = require("readline");
 var main_1 = require("./main");
 if (process.stdin.isTTY) {
-    // bysquare "file"
+    /** bysquare "file" */
     handleInput(process.argv[2]);
 }
 else {
-    // echo "data" | bysquare
+    /** echo "data" | bysquare */
+    ;
     (function () { return __awaiter(void 0, void 0, void 0, function () {
         var stdin, qrString;
         return __generator(this, function (_a) {
@@ -101,9 +102,8 @@ function jsonStringToQrString(stdin) {
             return [2 /*return*/, new Promise(function (resolve, reject) {
                     try {
                         var data = JSON.parse(stdin);
-                        (0, main_1.generate)(data).then(function (qrString) {
-                            resolve(qrString);
-                        });
+                        var qrString = (0, main_1.generate)(data);
+                        resolve(qrString);
                     }
                     catch (e) {
                         reject(e);
@@ -119,7 +119,7 @@ function handleStdin() {
             readline = (0, readline_1.createInterface)({
                 input: process.stdin,
                 output: process.stdout,
-                terminal: false,
+                terminal: false
             });
             lines = [];
             return [2 /*return*/, new Promise(function (resolve, reject) {
@@ -146,7 +146,6 @@ function help() {
         "",
         "Flags:",
         "   -h, --help    display this help and exit",
-        "   -v, --version display actual version",
         "",
         "If <file> is omitted, reads from stdin.",
         "",
@@ -154,7 +153,7 @@ function help() {
         "   bysquare ./example.json",
         "",
         "   echo ",
-        '       {',
+        "       {",
         '           "IBAN": "SK9611000000002918599669"',
         '           "Amount": 100.0',
         '           "CurrencyCode": "EUR"',
@@ -163,6 +162,6 @@ function help() {
         '           "PaymentOptions": 1',
         '           "BankAccounts": 1',
         "       }'",
-        "   | bysquare",
+        "   | bysquare"
     ].join("\n");
 }

package/lib/index.d.ts

@@ -1,2 +1,2 @@
 export * from './main';
-export * from './types';
+export * from './schema';

package/lib/index.js

@@ -11,4 +11,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./main"), exports);
-__exportStar(require("./types"), exports);
+__exportStar(require("./schema"), exports);

package/lib/main.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="node" />
-import { Model } from './types';
-export declare function generate(model: Model): Promise<string>;
+import { Model } from "./schema";
 /**
  * ```
  * | Attribute    | Number of bits | Possible values | Note
@@ -17,8 +16,9 @@ export declare function createHeader(header?: [
     DocumentType: number,
     Reserved: number
 ]): Buffer;
-export declare function tabbedStringWithChecksumBuffer(model: Model): Buffer;
-export declare function checksumFromTabbedString(tabbedString: string): Buffer;
+export declare function createChecksum(tabbedInput: string): Buffer;
+export declare function dataWithChecksum(model: Model): Buffer;
+export declare function generate(model: Model): Promise<string>;
 export declare function createTabbedString(model: Model): string;
-export declare function createModelFromTabbedString(tabbedModel: string): Model;
-export declare function parse(qrString: string): Promise<Model>;
+export declare function createModel(tabbedString: string): Model;
+export declare function parse(qr: string): Promise<Model>;

package/lib/main.js

@@ -24,71 +24,13 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     }
     return to.concat(ar || Array.prototype.slice.call(from));
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parse = exports.createModelFromTabbedString = exports.createTabbedString = exports.checksumFromTabbedString = exports.tabbedStringWithChecksumBuffer = exports.createHeader = exports.generate = void 0;
-var types_1 = require("./types");
-var lzma = require('lzma-native');
-function generate(model) {
-    var dataBufferWithChecksum = tabbedStringWithChecksumBuffer(model);
-    var encoder = lzma.createStream('rawEncoder', {
-        synchronous: true,
-        filters: [{ id: lzma.FILTER_LZMA1 }],
-    });
-    var data = [];
-    encoder.on('data', function (chunk) {
-        data.push(chunk);
-    });
-    var compressPromise = new Promise(function (resolve, reject) {
-        encoder.write(dataBufferWithChecksum, function () {
-            encoder.end();
-        });
-        encoder.on('error', reject);
-        encoder.on('end', function () {
-            /** (spec 3.5) */
-            var bySquareHeader = createHeader();
-            /**
-             * The header of compressed data is 2 bytes long and contains only
-             * one 16­bit unsigned integer (word, little­endian), which is the
-             * size of the decompressed data (spec 3.11)
-             */
-            var decompressedSize = Buffer.alloc(2);
-            decompressedSize.writeInt16LE(dataBufferWithChecksum.byteLength, 0);
-            /**
-             * Merged binary data (spec 3.15.)
-             */
-            var merged = Buffer.concat([
-                bySquareHeader,
-                decompressedSize,
-                Buffer.concat(data),
-            ]);
-            var paddedBinString = merged.reduce(function (acc, byte) { return (acc += byte.toString(2).padStart(8, '0')); }, '');
-            var paddedBinLength = paddedBinString.length;
-            var remainder = paddedBinLength % 5;
-            if (remainder) {
-                paddedBinString += Array(5 - remainder)
-                    .fill('0')
-                    .join('');
-                paddedBinLength += 5 - remainder;
-            }
-            /**
-             * Map a binary number of 5 bits to a string representation 2^5
-             * '0123456789ABCDEFGHIJKLMNOPQRSTUV'[0...32] represents char
-             */
-            var subst = '0123456789ABCDEFGHIJKLMNOPQRSTUV';
-            var output = '';
-            for (var i = 0; i < paddedBinLength / 5; i++) {
-                var binStart = 5 * i;
-                var binEnd = 5 * i + 5;
-                var slice = paddedBinString.slice(binStart, binEnd);
-                var key = parseInt(slice, 2);
-                output += subst[key];
-            }
-            resolve(output);
-        });
-    });
-    return compressPromise;
-}
-exports.generate = generate;
+exports.parse = exports.createModel = exports.createTabbedString = exports.generate = exports.dataWithChecksum = exports.createChecksum = exports.createHeader = void 0;
+var lzma_native_1 = __importDefault(require("lzma-native"));
+var schema_1 = require("./schema");
 /**
  * ```
  * | Attribute    | Number of bits | Possible values | Note
@@ -99,7 +41,9 @@ exports.generate = generate;
  * | Reserved     | 4              | 0-15            | bits reserved for future needs
  * ```
  */
-function createHeader(header) {
+function createHeader(
+// prettier-ignore
+header) {
     if (header === void 0) { header = [
         0,
         0,
@@ -113,27 +57,93 @@ function createHeader(header) {
     /** Combine 4-nibbles to 2-bytes */
     var headerBuffer = Buffer.from([
         (BySquareType << 4) | (Version << 0),
-        (DocumentType << 4) | (Reserved << 0),
+        (DocumentType << 4) | (Reserved << 0)
     ]);
     return headerBuffer;
 }
 exports.createHeader = createHeader;
-function tabbedStringWithChecksumBuffer(model) {
+function createChecksum(tabbedInput) {
+    // @ts-ignore: Wrong return type
+    var data = lzma_native_1.default.crc32(tabbedInput);
+    var crc32 = Buffer.alloc(4);
+    crc32.writeUInt32LE(data);
+    return crc32;
+}
+exports.createChecksum = createChecksum;
+function dataWithChecksum(model) {
     var tabbedString = createTabbedString(model);
-    var checksum = checksumFromTabbedString(tabbedString);
-    var data = Buffer.concat([
+    var checksum = createChecksum(tabbedString);
+    var merged = Buffer.concat([
         checksum,
-        Buffer.from(tabbedString, 'utf-8'),
+        Buffer.from(tabbedString, "utf-8")
     ]);
-    return data;
+    return merged;
 }
-exports.tabbedStringWithChecksumBuffer = tabbedStringWithChecksumBuffer;
-function checksumFromTabbedString(tabbedString) {
-    var crc32 = Buffer.alloc(4);
-    crc32.writeInt32LE(lzma.crc32(tabbedString), 0);
-    return crc32;
+exports.dataWithChecksum = dataWithChecksum;
+/**
+ * spec 3.13 (Table 9 – Encoding table)
+ */
+var SUBST = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
+function generate(model) {
+    var dataBuffer = dataWithChecksum(model);
+    var dataChunks = [];
+    return new Promise(function (resolve, reject) {
+        var encoder = lzma_native_1.default.createStream("rawEncoder", {
+            synchronous: true,
+            // @ts-ignore: Missing filter types
+            filters: [{ id: lzma_native_1.default.FILTER_LZMA1 }]
+        });
+        encoder
+            .on("data", function (chunk) {
+            dataChunks.push(chunk);
+        })
+            .on("error", Promise.reject)
+            .on("end", function () {
+            /**
+             * The header of compressed data is 2 bytes long and contains only
+             * one 16­bit unsigned integer (word, little­endian), which is the
+             * size of the decompressed data (spec 3.11)
+             */
+            var size = Buffer.alloc(2);
+            size.writeInt16LE(dataBuffer.byteLength, 0);
+            /** (spec 3.5) */
+            var header = createHeader();
+            /** Merged binary data (spec 3.15.) */
+            var merged = Buffer.concat([
+                header,
+                size,
+                Buffer.concat(dataChunks)
+            ]);
+            var paddedBinString = merged.reduce(function (acc, byte) { return acc + byte.toString(2).padStart(8, "0"); }, "");
+            var paddedBinLength = paddedBinString.length;
+            var remainder = paddedBinLength % 5;
+            if (remainder) {
+                paddedBinString += Array(5 - remainder)
+                    .fill("0")
+                    .join("");
+                paddedBinLength += 5 - remainder;
+            }
+            /**
+             * Map a binary number of 5 bits to a string representation 2^5
+             * '0123456789ABCDEFGHIJKLMNOPQRSTUV'[0...32] represents char
+             */
+            var output = "";
+            for (var i = 0; i < paddedBinLength / 5; i++) {
+                var binStart = 5 * i;
+                var binEnd = 5 * i + 5;
+                var slice = paddedBinString.slice(binStart, binEnd);
+                var key = parseInt(slice, 2);
+                output += SUBST[key];
+            }
+            return resolve(output);
+        })
+            .write(dataBuffer, function (err) {
+            err && reject(err);
+            encoder.end();
+        });
+    });
 }
-exports.checksumFromTabbedString = checksumFromTabbedString;
+exports.generate = generate;
 function createTabbedString(model) {
     /**
      * Order keys by specification
@@ -143,35 +153,36 @@ function createTabbedString(model) {
     var tabbedModel = Object.keys(model)
         .reduce(function (acc, key) {
         var _a;
-        acc[types_1.ModelOrdered[key]] = String((_a = model[key]) !== null && _a !== void 0 ? _a : '');
+        acc[schema_1.ModelOrdered[key]] = String((_a = model[key]) !== null && _a !== void 0 ? _a : "");
         return acc;
-    }, Array(33).fill(''))
-        .join('\t');
+    }, Array(33).fill(""))
+        .join("\t");
     return tabbedModel;
 }
 exports.createTabbedString = createTabbedString;
-function createModelFromTabbedString(tabbedModel) {
-    var model = tabbedModel
-        .split('\t')
+function createModel(tabbedString) {
+    var model = tabbedString
+        .split("\t")
+        .filter(function (ch) { return !(ch === "\x00"); })
         .reduce(function (acc, value, i) {
-        var key = types_1.ModelOrdered[i];
-        if (value === '') {
+        var key = schema_1.ModelOrdered[i];
+        if (value === "") {
             return acc;
         }
-        var numberKeys = [
-            'Payments',
-            'PaymentOptions',
-            'Amount',
-            'BankAccounts',
-            'StandingOrderExt',
-            'Day',
-            'Month',
-            'DirectDebitExt',
-            'DirectDebitScheme',
-            'DirectDebitType',
-            'MaxAmount',
+        var numericKeys = [
+            "Payments",
+            "PaymentOptions",
+            "Amount",
+            "BankAccounts",
+            "StandingOrderExt",
+            "Day",
+            "Month",
+            "DirectDebitExt",
+            "DirectDebitScheme",
+            "DirectDebitType",
+            "MaxAmount"
         ];
-        if (!!Number(value) && numberKeys.includes(key)) {
+        if (numericKeys.includes(key)) {
             acc[key] = Number(value);
             return acc;
         }
@@ -180,46 +191,44 @@ function createModelFromTabbedString(tabbedModel) {
     }, {});
     return model;
 }
-exports.createModelFromTabbedString = createModelFromTabbedString;
-function parse(qrString) {
-    var subst = '0123456789ABCDEFGHIJKLMNOPQRSTUV';
-    var paddedBinString = __spreadArray([], __read(qrString), false).reduce(function (acc, char) {
-        acc += subst.indexOf(char).toString(2).padStart(5, '0');
+exports.createModel = createModel;
+function parse(qr) {
+    var binary = __spreadArray([], __read(qr), false).reduce(function (acc, char) {
+        acc += SUBST.indexOf(char).toString(2).padStart(5, "0");
         return acc;
-    }, '');
+    }, "");
     var bytes = [];
-    for (var count = 0, leftCount = 0; paddedBinString.length > leftCount; count++) {
-        var byte = parseInt(paddedBinString.slice(leftCount, (leftCount += 8)), 2)
-            .toString(16)
-            .padStart(2, '0');
-        bytes[count] = byte;
+    for (var nth = 0, leftCount = 0; binary.length > leftCount; nth++) {
+        var byte = parseInt(binary.slice(leftCount, (leftCount += 8)), 2);
+        bytes[nth] = byte;
     }
-    var binaryData = Buffer.from(bytes.join(''), 'hex');
-    var _header = binaryData.slice(0, 2);
-    var _decompressSize = binaryData.slice(2, 4);
-    var data = binaryData.slice(4, binaryData.length);
-    var decoder = lzma.createStream('rawDecoder', {
+    var input = Buffer.from(bytes);
+    // const header = input.slice(0, 2)
+    // const size = input.slice(2, 4)
+    var data = input.slice(4);
+    // @ts-ignore: Missing decored types
+    var decoder = lzma_native_1.default.createStream("rawDecoder", {
         synchronous: true,
-        filters: [{ id: lzma.FILTER_LZMA1 }],
+        // @ts-ignore: Missing filter types
+        filters: [{ id: lzma_native_1.default.FILTER_LZMA1 }]
     });
-    decoder.write(data, undefined, function () {
-        decoder.end();
-    });
-    var paymentPromise = new Promise(function (resolve, reject) {
-        decoder.on('error', reject);
-        decoder.on('data', function (decompressed) {
-            var checksum = decompressed.slice(0, 4);
-            var data = decompressed.slice(4, decompressed.length);
-            var crc32 = Buffer.alloc(4);
-            crc32.writeInt32LE(lzma.crc32(data), 0);
-            if (!crc32.equals(checksum)) {
-                reject('Checksum conflict');
-            }
-            var decoded = data.toString();
-            var model = createModelFromTabbedString(decoded);
+    return new Promise(function (resolve, reject) {
+        decoder
+            .on("error", reject)
+            .on("data", function (decompress) {
+            var checksum = decompress.slice(0, 4);
+            var data = decompress.slice(4).toString();
+            // TODO: Not neccesary to validate, but data can be corrupted
+            // if (!createChecksum(data).equals(checksum)) {
+            // 	reject("Checksum conflict")
+            // }
+            var model = createModel(data);
             resolve(model);
+        })
+            .write(data, function (err) {
+            err && reject(err);
+            decoder.end();
         });
     });
-    return paymentPromise;
 }
 exports.parse = parse;

package/lib/{types.d.ts → schema.d.ts}

@@ -1,4 +1,6 @@
 /**
+ * TODO: yup schema, infer interface
+ *
  * Data model
  * (Appendix D, table)
  */

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "bysquare",
     "description": "It's a national standard for payment QR codes adopted by Slovak Banking Association (SBA)",
-    "version": "1.0.8",
+    "version": "1.1.0",
     "license": "Apache-2.0",
     "author": "Filip Seman <filip.seman@protonmail.com>",
     "keywords": [
@@ -34,19 +34,24 @@
         "lzma-native": "8.0.6"
     },
     "devDependencies": {
+        "@types/lzma-native": "^4.0.1",
         "@types/node": "14.14.20",
         "typescript": "4.5.5",
         "xv": "1.1.1"
     },
-    "engines": {
-        "node": ">=14.14.x",
-        "npm": ">= 7.0"
-    },
     "files": [
         "lib",
         "!lib/*.test.*"
     ],
     "bin": "lib/cli.js",
     "main": "lib/index.js",
-    "types": "lib/index.d.ts"
+    "types": "lib/index.d.ts",
+    "engines": {
+        "node": ">=14.14.x",
+        "npm": ">= 7.0"
+    },
+    "os": [
+        "darwin",
+        "linux"
+    ]
 }