bysquare 1.3.0 → 1.3.2

package/lib/generate.d.ts

@@ -41,4 +41,7 @@ export declare function makeTabbed(model: Model): string;
  * @see 3.13. Alphanumeric conversion using Base32hex
  */
 export declare function alphanumericConversion(data: Buffer): string;
+/**
+ * Generate QR string ready for encoding into basic QR code
+ */
 export declare function generate(model: Model): Promise<string>;

package/lib/generate.js

@@ -24,6 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generate = exports.alphanumericConversion = exports.makeTabbed = exports.prepareForCompression = exports.makeChecksum = exports.makeHeaderBysquare = void 0;
+const lodash_es_1 = require("lodash-es");
 const lzma = __importStar(require("lzma-native"));
 const index_1 = require("./index");
 // echo "Hello" | xz --format=raw --lzma1=lc=3,lp=0,pb=2,dict=32KiB --stdout | hexdump -C
@@ -108,6 +109,11 @@ exports.prepareForCompression = prepareForCompression;
 function makeTabbed(model) {
     const tabbed = Object.keys(model).reduce((acc, key) => {
         const index = index_1.SequenceOrder[key];
+        /** Diacritical marks are not allowed */
+        if (key === "PaymentNote") {
+            acc[index] = (0, lodash_es_1.deburr)(model[key]);
+            return acc;
+        }
         acc[index] = String(model[key]);
         return acc;
     }, Array(33).fill(undefined));
@@ -159,6 +165,9 @@ function alphanumericConversion(data) {
     return encoded;
 }
 exports.alphanumericConversion = alphanumericConversion;
+/**
+ * Generate QR string ready for encoding into basic QR code
+ */
 function generate(model) {
     const data = prepareForCompression(model);
     const compressedData = [];

package/lib/parse.js

@@ -26,9 +26,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.detect = exports.inverseAlphanumericConversion = exports.parse = exports.assemble = void 0;
 const lzma = __importStar(require("lzma-native"));
 const index_1 = require("./index");
-const FIELDS_INVOICE = 0;
-const FIELDS_NUMBER_OF_PAYMENTS = 1;
-const FIELDS_PAYMENT_OPTIONS = 2;
+const FIELD_INVOICE = 0;
+const FIELD_PAYMENT_COUNT = 1;
+const FIELD_PAYMENT_OPTIONS = 2;
+const FIELD_BANK_ACCOUNT_COUNT = 11;
 /**
  * @see 3.14. Generating by square Code
  */
@@ -37,15 +38,19 @@ function assemble(tabbed) {
         .split("\t")
         /** The end of the qr-string might contain a NULL-terminated string */
         .map((entry) => entry.replace("\x00", ""));
-    const invoiceId = fields[FIELDS_INVOICE];
+    const invoiceId = fields[FIELD_INVOICE];
     const output = {
-        invoiceId: !!invoiceId.length ? invoiceId : undefined,
+        invoiceId: invoiceId?.length ? invoiceId : undefined,
         payments: []
     };
-    const paymentsCount = Number(fields[FIELDS_NUMBER_OF_PAYMENTS]);
-    const paymentOptions = Number(fields[FIELDS_PAYMENT_OPTIONS]);
+    const paymentsCount = Number(fields[FIELD_PAYMENT_COUNT]);
+    const paymentOptions = Number(fields[FIELD_PAYMENT_OPTIONS]);
+    const bankAccountsCount = Number(fields[FIELD_BANK_ACCOUNT_COUNT]);
     for (let i = 0; i < paymentsCount; i++) {
-        const payment = fields.slice(3 + i, 11 + i);
+        const paymentFieldCount = 8;
+        const paymentFieldStart = 3 + (i * paymentFieldCount);
+        const paymentFieldEnd = 11 + (i * paymentFieldCount);
+        const payment = fields.slice(paymentFieldStart, paymentFieldEnd);
         const [ammount, currencyCode, paymentDueDate, variableSymbol, constantSymbol, specificSymbol, originatorsReferenceInformation, paymentNote] = payment;
         output.payments.push({
             amount: ammount.length ? Number(ammount) : undefined,
@@ -56,17 +61,17 @@ function assemble(tabbed) {
             specificSymbol: specificSymbol?.length ? specificSymbol : undefined,
             originatorsReferenceInformation: originatorsReferenceInformation?.length ? originatorsReferenceInformation : undefined,
             paymentNote: paymentNote?.length ? paymentNote : undefined,
-            bankAccounts: []
+            bankAccounts: [],
         });
-        const bankAccounts = fields.slice(11 + i, 15 + i);
-        const [bankAccountsCount, iban, bic] = bankAccounts;
-        if (bankAccountsCount?.length === 0) {
-            throw new Error("Missing bank accounts count");
-        }
-        if (iban?.length === 0) {
-            throw new Error("Missing IBAN");
-        }
         for (let j = 0; j < Number(bankAccountsCount); j++) {
+            const bankAccountFieldCount = 2;
+            const bankAccountFieldStart = 12 + (j * bankAccountFieldCount);
+            const bankAccountFieldEnd = 14 + (j * bankAccountFieldCount);
+            const bankAccounts = fields.slice(bankAccountFieldStart, bankAccountFieldEnd);
+            const [iban, bic] = bankAccounts;
+            if (iban?.length === 0) {
+                throw new Error("Missing IBAN");
+            }
             output.payments[i].bankAccounts.push({
                 iban: iban,
                 bic: bic?.length ? bic : undefined
@@ -76,7 +81,10 @@ function assemble(tabbed) {
             case index_1.PaymentOptions.PaymentOrder:
                 break;
             case index_1.PaymentOptions.StandingOrder:
-                const standingOrder = fields.slice(15 + i, 20 + i);
+                const standingOrderFieldCount = 4;
+                const standingOrderFieldStart = 15 + (i * standingOrderFieldCount);
+                const standingOrderFieldEnd = 20 + (i * standingOrderFieldCount);
+                const standingOrder = fields.slice(standingOrderFieldStart, standingOrderFieldEnd);
                 const [day, month, periodicity, lastDate] = standingOrder;
                 output.payments[i].standingOrder = {
                     day: day?.length ? Number(day) : undefined,
@@ -86,7 +94,10 @@ function assemble(tabbed) {
                 };
                 break;
             case index_1.PaymentOptions.DirectDebit:
-                const directDebit = fields.slice(16 + i, 26 + i);
+                const directDebitFieldCount = 10;
+                const directDebitFieldStart = 16 + (i * directDebitFieldCount);
+                const directDebitFieldEnd = 27 + (i * directDebitFieldStart);
+                const directDebit = fields.slice(directDebitFieldStart, directDebitFieldEnd);
                 const [directDebitScheme, directDebitType, variableSymbol, specificSymbol, originatorsReferenceInformation, mandateId, creditorId, contractId, maxAmount, validTillDate,] = directDebit;
                 output.payments[i].directDebit = {
                     directDebitScheme: directDebitScheme.length ? Number(directDebitScheme) : undefined,
@@ -107,15 +118,16 @@ function assemble(tabbed) {
     /** Beneficiary list bysquare v1.1 */
     for (let i = 0; i < paymentsCount; i++) {
         let beneficiary = [];
+        const offset = (i || 1) * (2 * bankAccountsCount) - 2;
         switch (paymentOptions) {
             case index_1.PaymentOptions.PaymentOrder:
-                beneficiary = fields.slice(16 + i, 20 + i);
+                beneficiary = fields.slice(16 + offset, 20 + offset);
                 break;
             case index_1.PaymentOptions.StandingOrder:
-                beneficiary = fields.slice(20 + i, 24 + i);
+                beneficiary = fields.slice(20 + offset, 24 + offset);
                 break;
             case index_1.PaymentOptions.DirectDebit:
-                beneficiary = fields.slice(25 + i, 29 + i);
+                beneficiary = fields.slice(25 + offset, 29 + offset);
                 break;
         }
         if (beneficiary.length === 0) {

package/lib/types.d.ts

@@ -2,13 +2,13 @@
  * The bit sequence is split into 5 bit chunks which are mapped onto the
  * characters
  *
- * @see {spec 3.13. Table 9 – Encoding table}
+ * @see 3.13. Table 9 – Encoding table
  */
 export declare const SUBST = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
 export declare enum PaymentOptions {
     PaymentOrder = 1,
     StandingOrder = 2,
-    DirectDebit = 3
+    DirectDebit = 4
 }
 export declare enum MonthClassifier {
     January = 1,

package/lib/types.js

@@ -5,7 +5,7 @@ exports.CurrencyCode = exports.SequenceOrder = exports.DirectDebitScheme = expor
  * The bit sequence is split into 5 bit chunks which are mapped onto the
  * characters
  *
- * @see {spec 3.13. Table 9 – Encoding table}
+ * @see 3.13. Table 9 – Encoding table
  */
 exports.SUBST = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
 /**
@@ -31,7 +31,7 @@ var PaymentOptions;
 (function (PaymentOptions) {
     PaymentOptions[PaymentOptions["PaymentOrder"] = 1] = "PaymentOrder";
     PaymentOptions[PaymentOptions["StandingOrder"] = 2] = "StandingOrder";
-    PaymentOptions[PaymentOptions["DirectDebit"] = 3] = "DirectDebit";
+    PaymentOptions[PaymentOptions["DirectDebit"] = 4] = "DirectDebit";
 })(PaymentOptions = exports.PaymentOptions || (exports.PaymentOptions = {}));
 var MonthClassifier;
 (function (MonthClassifier) {
@@ -46,7 +46,7 @@ var MonthClassifier;
     MonthClassifier[MonthClassifier["September"] = 256] = "September";
     MonthClassifier[MonthClassifier["October"] = 512] = "October";
     MonthClassifier[MonthClassifier["November"] = 1024] = "November";
-    MonthClassifier[MonthClassifier["December"] = 2048] = "December";
+    MonthClassifier[MonthClassifier["December"] = 2048] = "December"; // 2^11
 })(MonthClassifier = exports.MonthClassifier || (exports.MonthClassifier = {}));
 var PeriodicityClassifier;
 (function (PeriodicityClassifier) {

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.3.0",
+	"version": "1.3.2",
 	"license": "Apache-2.0",
 	"author": "Filip Seman <filip.seman@protonmail.com>",
 	"keywords": [
@@ -34,9 +34,11 @@
 		"postversion": ""
 	},
 	"dependencies": {
+		"lodash-es": "~4.17.0",
 		"lzma-native": "8.0.6"
 	},
 	"devDependencies": {
+		"@types/lodash-es": "~4.17.0",
 		"@types/lzma-native": "^4.0.1",
 		"@types/node": ">=14",
 		"typescript": "~4.7.0",