bysquare 1.3.3 → 2.0.0

package/lib/parse.d.ts

@@ -1,21 +1,16 @@
-/// <reference types="node" />
-import { ParsedModel } from "./index";
+import { DataModel } from "./index.js";
 /**
  * @see 3.14. Generating by square Code
  */
-export declare function assemble(tabbed: string): ParsedModel;
+export declare function buildModel(qr: string): DataModel;
 /**
  * @see 3.16. Decoding client data from QR Code 2005 symbol
  */
-export declare function parse(qr: string): Promise<ParsedModel>;
+export declare function parse(qr: string): Promise<DataModel>;
 /**
- * @see 3.13. Alphanumeric conversion using Base32hex
- */
-export declare function inverseAlphanumericConversion(qr: string): Buffer;
-/**
- * Simple binary header detector
+ * Detect if qr string contains bysquare header.
  *
- * The Bysquare header is pretty useless, so the detection isn't as reliable as
- * I'd like
+ * Bysquare header does not have too much information, therefore it is
+ * not very reliable, there is room for improvement for the future.
  */
 export declare function detect(qr: string): boolean;

package/lib/parse.js

@@ -1,163 +1,128 @@
-"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-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 FIELD_INVOICE = 0;
-const FIELD_PAYMENT_COUNT = 1;
-const FIELD_PAYMENT_OPTIONS = 2;
-const FIELD_BANK_ACCOUNT_COUNT = 11;
+import lzma from "lzma-native";
+import { base32hex } from "rfc4648";
+import { PaymentOptions } from "./index.js";
+function cleanEmptyProps(obj) {
+    Object.keys(obj).forEach((key) => {
+        if (typeof obj[key] === 'undefined') {
+            delete obj[key];
+        }
+    });
+}
 /**
  * @see 3.14. Generating by square Code
  */
-function assemble(tabbed) {
-    const fields = tabbed
+export function buildModel(qr) {
+    const intermediate = qr
         .split("\t")
         /** The end of the qr-string might contain a NULL-terminated string */
         .map((entry) => entry.replace("\x00", ""));
-    const invoiceId = fields[FIELD_INVOICE];
+    const invoiceId = intermediate.shift();
     const output = {
         invoiceId: invoiceId?.length ? invoiceId : undefined,
         payments: []
     };
-    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 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,
-            currencyCode: currencyCode,
-            paymentDueDate: paymentDueDate?.length ? paymentDueDate : undefined,
-            variableSymbol: variableSymbol?.length ? variableSymbol : undefined,
-            constantSymbol: constantSymbol?.length ? constantSymbol : undefined,
-            specificSymbol: specificSymbol?.length ? specificSymbol : undefined,
-            originatorsReferenceInformation: originatorsReferenceInformation?.length ? originatorsReferenceInformation : undefined,
-            paymentNote: paymentNote?.length ? paymentNote : undefined,
+    const paymentslen = Number(intermediate.shift());
+    for (let i = 0; i < paymentslen; i++) {
+        const paymentOptions = intermediate.shift();
+        const ammount = intermediate.shift();
+        const currency = intermediate.shift();
+        const dueDate = intermediate.shift();
+        const variables = intermediate.shift();
+        const constants = intermediate.shift();
+        const specifics = intermediate.shift();
+        const originatorRefInfo = intermediate.shift();
+        const paymentNote = intermediate.shift();
+        let payment = {
+            type: Number(paymentOptions),
             bankAccounts: [],
-        });
-        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) {
+            amount: ammount?.length ? Number(ammount) : undefined,
+            currencyCode: currency,
+            paymentDueDate: dueDate?.length ? dueDate : undefined,
+            variableSymbol: variables?.length ? variables : undefined,
+            constantSymbol: constants?.length ? constants : undefined,
+            specificSymbol: specifics?.length ? specifics : undefined,
+            originatorRefInfo: originatorRefInfo?.length ? originatorRefInfo : undefined,
+            paymentNote: paymentNote?.length ? paymentNote : undefined,
+        };
+        const accountslen = Number(intermediate.shift());
+        for (let j = 0; j < accountslen; j++) {
+            const iban = intermediate.shift();
+            if (iban === undefined || iban.length === 0) {
                 throw new Error("Missing IBAN");
             }
-            output.payments[i].bankAccounts.push({
+            const bic = intermediate.shift();
+            const account = {
                 iban: iban,
-                bic: bic?.length ? bic : undefined
-            });
+                bic: bic?.length ? bic : undefined,
+            };
+            cleanEmptyProps(account);
+            payment.bankAccounts.push(account);
         }
-        switch (paymentOptions) {
-            case index_1.PaymentOptions.PaymentOrder:
+        intermediate.shift(); // StandingOrderExt
+        intermediate.shift(); // DirectDebitExt
+        // narrowing payment type
+        switch (payment.type) {
+            case PaymentOptions.PaymentOrder:
                 break;
-            case index_1.PaymentOptions.StandingOrder:
-                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,
-                    month: month?.length ? Number(month) : undefined,
-                    periodicity: periodicity?.length ? periodicity : undefined,
-                    lastDate: lastDate?.length ? lastDate : undefined
+            case PaymentOptions.StandingOrder:
+                payment = {
+                    ...payment,
+                    day: Number(intermediate.shift()),
+                    month: Number(intermediate.shift()),
+                    periodicity: intermediate.shift(),
+                    lastDate: intermediate.shift()
                 };
                 break;
-            case index_1.PaymentOptions.DirectDebit:
-                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,
-                    directDebitType: directDebitType.length ? Number(directDebitType) : undefined,
-                    variableSymbol: variableSymbol.length ? variableSymbol : undefined,
-                    specificSymbol: specificSymbol.length ? specificSymbol : undefined,
-                    originatorsReferenceInformation: originatorsReferenceInformation.length ? originatorsReferenceInformation : undefined,
-                    mandateId: mandateId.length ? mandateId : undefined,
-                    creditorId: creditorId.length ? creditorId : undefined,
-                    contractId: contractId.length ? contractId : undefined,
-                    maxAmount: maxAmount.length ? Number(maxAmount) : undefined,
-                    validTillDate: validTillDate.length ? validTillDate : undefined
+            case PaymentOptions.DirectDebit:
+                payment = {
+                    ...payment,
+                    directDebitScheme: Number(intermediate.shift()),
+                    directDebitType: Number(intermediate.shift()),
+                    mandateId: intermediate.shift(),
+                    creditorId: intermediate.shift(),
+                    contractId: intermediate.shift(),
+                    maxAmount: Number(intermediate.shift()),
+                    validTillDate: intermediate.shift()
                 };
-            default:
-                throw new Error("Unknown payment option");
-        }
-    }
-    /** 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 + offset, 20 + offset);
                 break;
-            case index_1.PaymentOptions.StandingOrder:
-                beneficiary = fields.slice(20 + offset, 24 + offset);
-                break;
-            case index_1.PaymentOptions.DirectDebit:
-                beneficiary = fields.slice(25 + offset, 29 + offset);
+            default:
                 break;
         }
-        if (beneficiary.length === 0) {
-            break;
-        }
-        const [name, addressLine1, addressLine2] = beneficiary;
-        /**
-         * The list of recipients is optional, if we find a missing record, the
-         * stream ends
-         */
-        if (!name && !addressLine1 && !addressLine2) {
-            break;
+        cleanEmptyProps(payment);
+        output.payments.push(payment);
+    }
+    for (let i = 0; i < paymentslen; i++) {
+        const name = intermediate.shift();
+        const addressLine1 = intermediate.shift();
+        const addressLine2 = intermediate.shift();
+        if (Boolean(name) || Boolean(addressLine1) || Boolean(addressLine2)) {
+            const beneficiary = {
+                name: name?.length ? name : undefined,
+                street: addressLine1?.length ? addressLine1 : undefined,
+                city: addressLine2?.length ? addressLine2 : undefined,
+            };
+            cleanEmptyProps(beneficiary);
+            output.payments[i].beneficiary = beneficiary;
         }
-        output.payments[i].beneficiary = {
-            name: name?.length ? name : undefined,
-            addressLine1: addressLine1?.length ? addressLine1 : undefined,
-            addressLine2: addressLine2?.length ? addressLine2 : undefined
-        };
     }
     return output;
 }
-exports.assemble = assemble;
 /**
  * @see 3.16. Decoding client data from QR Code 2005 symbol
  */
-function parse(qr) {
-    const inversed = inverseAlphanumericConversion(qr);
-    const _headerBysquare = inversed.slice(0, 2);
-    const _headerCompression = inversed.slice(2, 4);
-    const compressedData = inversed.slice(4);
+export function parse(qr) {
+    try {
+        var decoded = base32hex.parse(qr, {
+            out: Buffer,
+            loose: true
+        });
+    }
+    catch {
+        throw new Error("Unable to parse QR");
+    }
+    // const bysquareHeader = decoded.subarray(0, 2)
+    // const compressionHeader = decoded.subarray(2, 4)
+    const compressedData = decoded.subarray(4);
     // @ts-ignore: Missing decored types
     const decoder = lzma.createStream("rawDecoder", {
         synchronous: true,
@@ -166,57 +131,44 @@ function parse(qr) {
     });
     return new Promise((resolve, reject) => {
         decoder
-            .on("error", reject)
             .on("data", (decompress) => {
-            const _crc32 = decompress.slice(0, 4);
-            const tabbed = decompress.slice(4).toString();
-            const model = assemble(tabbed);
-            resolve(model);
+            // const crc32: Buffer = decompress.subarray(0, 4)
+            const tabbed = decompress.subarray(4).toString();
+            resolve(buildModel(tabbed));
         })
+            .on("error", reject)
             .write(compressedData, (error) => {
             error && reject(error);
             decoder.end();
         });
     });
 }
-exports.parse = parse;
 /**
- * @see 3.13. Alphanumeric conversion using Base32hex
- */
-function inverseAlphanumericConversion(qr) {
-    const binary = [...qr].reduce((acc, char) => {
-        acc += index_1.SUBST.indexOf(char).toString(2).padStart(5, "0");
-        return acc;
-    }, "");
-    let bytes = [];
-    for (let nth = 0, leftCount = 0; binary.length > leftCount; nth++) {
-        /** string representation of 8-bits */
-        const slice = binary.slice(leftCount, (leftCount += 8));
-        const byte = parseInt(slice, 2);
-        bytes[nth] = byte;
-    }
-    return Buffer.from(bytes);
-}
-exports.inverseAlphanumericConversion = inverseAlphanumericConversion;
-/**
- * Simple binary header detector
+ * Detect if qr string contains bysquare header.
  *
- * The Bysquare header is pretty useless, so the detection isn't as reliable as
- * I'd like
+ * Bysquare header does not have too much information, therefore it is
+ * not very reliable, there is room for improvement for the future.
  */
-function detect(qr) {
-    const inversed = inverseAlphanumericConversion(qr);
-    if (inversed.byteLength < 2) {
+export function detect(qr) {
+    try {
+        var parsed = base32hex.parse(qr, {
+            out: Buffer,
+            loose: true
+        });
+    }
+    catch {
+        throw new Error("Unable to parse QR string, invalid data");
+    }
+    if (parsed.byteLength < 2) {
         return false;
     }
-    const headerBysquare = inversed.slice(0, 2);
+    const headerBysquare = parsed.subarray(0, 2);
     return [...headerBysquare.toString("hex")]
         .map((nibble) => parseInt(nibble, 16))
         .every((nibble, index) => {
-        if (index === 1 /** version */) {
+        if ( /** version */index === 1) {
             return 0 >= nibble && nibble <= 1;
         }
         return 0 <= nibble && nibble <= 15;
     });
 }
-exports.detect = detect;