bysquare 2.0.1 → 2.2.0

package/lib/cjs/parse.js

@@ -1,71 +1,106 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+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.parse = exports.buildModel = void 0;
-const lzma_native_1 = __importDefault(require("lzma-native"));
+exports.detect = exports.parse = exports.DecodeError = exports.deserialize = void 0;
+const lzma = __importStar(require("lzma1"));
 const rfc4648_1 = require("rfc4648");
 const index_js_1 = require("./index.js");
 function cleanEmptyProps(obj) {
     Object.keys(obj).forEach((key) => {
-        if (typeof obj[key] === 'undefined') {
+        if (typeof obj[key] === "undefined") {
             delete obj[key];
         }
     });
 }
 /**
- * @see 3.14. Generating by square Code
+ * Generating by square Code
+ *
+ * @see 3.14.
  */
-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 = intermediate.shift();
+function deserialize(qr) {
+    const serialized = qr.split("\t");
+    const invoiceId = serialized.shift();
     const output = {
         invoiceId: invoiceId?.length ? invoiceId : undefined,
         payments: []
     };
-    const paymentslen = Number(intermediate.shift());
+    const paymentslen = Number(serialized.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();
+        const paymentOptions = serialized.shift();
+        const ammount = serialized.shift();
+        const currency = serialized.shift();
+        const dueDate = serialized.shift();
+        const variables = serialized.shift();
+        const constants = serialized.shift();
+        const specifics = serialized.shift();
+        const originatorRefInfo = serialized.shift();
+        const paymentNote = serialized.shift();
         let payment = {
-            type: Number(paymentOptions),
             bankAccounts: [],
-            amount: ammount?.length ? Number(ammount) : undefined,
+            type: Number(paymentOptions),
             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,
+            amount: ammount?.length
+                ? Number(ammount)
+                : undefined,
+            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());
+        const accountslen = Number(serialized.shift());
         for (let j = 0; j < accountslen; j++) {
-            const iban = intermediate.shift();
+            const iban = serialized.shift();
             if (iban === undefined || iban.length === 0) {
                 throw new Error("Missing IBAN");
             }
-            const bic = intermediate.shift();
+            const bic = serialized.shift();
             const account = {
                 iban: iban,
-                bic: bic?.length ? bic : undefined,
+                bic: bic?.length
+                    ? bic
+                    : undefined
             };
             cleanEmptyProps(account);
             payment.bankAccounts.push(account);
         }
-        intermediate.shift(); // StandingOrderExt
-        intermediate.shift(); // DirectDebitExt
+        serialized.shift(); // StandingOrderExt
+        serialized.shift(); // DirectDebitExt
         // narrowing payment type
         switch (payment.type) {
             case index_js_1.PaymentOptions.PaymentOrder:
@@ -73,22 +108,22 @@ function buildModel(qr) {
             case index_js_1.PaymentOptions.StandingOrder:
                 payment = {
                     ...payment,
-                    day: Number(intermediate.shift()),
-                    month: Number(intermediate.shift()),
-                    periodicity: intermediate.shift(),
-                    lastDate: intermediate.shift()
+                    day: Number(serialized.shift()),
+                    month: Number(serialized.shift()),
+                    periodicity: serialized.shift(),
+                    lastDate: serialized.shift()
                 };
                 break;
             case index_js_1.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()
+                    directDebitScheme: Number(serialized.shift()),
+                    directDebitType: Number(serialized.shift()),
+                    mandateId: serialized.shift(),
+                    creditorId: serialized.shift(),
+                    contractId: serialized.shift(),
+                    maxAmount: Number(serialized.shift()),
+                    validTillDate: serialized.shift()
                 };
                 break;
             default:
@@ -98,14 +133,20 @@ function buildModel(qr) {
         output.payments.push(payment);
     }
     for (let i = 0; i < paymentslen; i++) {
-        const name = intermediate.shift();
-        const addressLine1 = intermediate.shift();
-        const addressLine2 = intermediate.shift();
+        const name = serialized.shift();
+        const addressLine1 = serialized.shift();
+        const addressLine2 = serialized.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,
+                name: name?.length
+                    ? name
+                    : undefined,
+                street: addressLine1?.length
+                    ? addressLine1
+                    : undefined,
+                city: addressLine2?.length
+                    ? addressLine2
+                    : undefined
             };
             cleanEmptyProps(beneficiary);
             output.payments[i].beneficiary = beneficiary;
@@ -113,42 +154,113 @@ function buildModel(qr) {
     }
     return output;
 }
-exports.buildModel = buildModel;
+exports.deserialize = deserialize;
+/**
+ * LZMA compression properties from the byte
+ *
+ * @param props 1-byte size
+ */
+function LzmaPropertiesDecoder(props) {
+    const byte = props[0];
+    return {
+        lc: byte >> 5,
+        lp: byte >> 2 & 0b0111,
+        pb: byte & 0b0011
+    };
+}
+function calcLzmaDictionarySize(props) {
+    const dictionarySize = new ArrayBuffer(4);
+    new DataView(dictionarySize).setUint32(0, Math.pow(2, props.pb + props.lp));
+    return new Uint8Array(dictionarySize);
+}
 /**
- * @see 3.16. Decoding client data from QR Code 2005 symbol
+ * The function uses bit-shifting and masking to convert the first two bytes of
+ * the input header array into four nibbles representing the bysquare header
+ * values.
+ *
+ * @param header 2-bytes sie
+ */
+function bysquareHeaderDecoder(header) {
+    const bytes = (header[0] << 8) | header[1];
+    const bysquareType = bytes >> 12;
+    const version = (bytes >> 8) & 0b1111;
+    const documentType = (bytes >> 4) & 0b1111;
+    const reserved = bytes & 0b1111;
+    return {
+        bysquareType,
+        version,
+        documentType,
+        reserved
+    };
+}
+class DecodeError extends Error {
+    cause;
+    name = "DecodeError";
+    constructor(cause, msg) {
+        super(msg);
+        this.cause = cause;
+    }
+}
+exports.DecodeError = DecodeError;
+/**
+ * Decoding client data from QR Code 2005 symbol
+ *
+ * @see 3.16.
  */
 function parse(qr) {
     try {
-        var decoded = rfc4648_1.base32hex.parse(qr, {
-            out: Buffer,
+        var bytes = rfc4648_1.base32hex.parse(qr, {
             loose: true
         });
     }
-    catch {
-        throw new Error("Unable to parse QR");
+    catch (error) {
+        throw new DecodeError(error, "Unable to decode QR string base32hex encoding");
     }
-    // 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_native_1.default.createStream("rawDecoder", {
-        synchronous: true,
-        // @ts-ignore: Missing filter types
-        filters: [{ id: lzma_native_1.default.FILTER_LZMA1 }]
-    });
-    return new Promise((resolve, reject) => {
-        decoder
-            .on("data", (decompress) => {
-            // 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();
-        });
-    });
+    const bysquareHeader = bytes.slice(0, 2);
+    const { version } = bysquareHeaderDecoder(bysquareHeader);
+    if ((version > 1 /* Version["1.1.0"] */)) {
+        throw new Error("Unsupported Bysquare version");
+    }
+    /**
+     * The process of decompressing data requires the addition of an LZMA header
+     * to the compressed data. This header is necessary for the decompression
+     * algorithm to properly interpret and extract the original uncompressed
+     * data. Bysquare only store properties
+     *
+     * <----------------------- 13-bytes ----------------------->
+     *
+     * +------------+----+----+----+----+--+--+--+--+--+--+--+--+
+     * | Properties |  Dictionary Size  |   Uncompressed Size   |
+     * +------------+----+----+----+----+--+--+--+--+--+--+--+--+
+     */
+    const lzmaProperties = bytes.slice(2, 3);
+    const decodedProps = LzmaPropertiesDecoder(lzmaProperties);
+    const dictSize = calcLzmaDictionarySize(decodedProps);
+    const header = new Uint8Array([
+        lzmaProperties[0],
+        ...dictSize,
+        /** Uncompressed size, this value indicates that size is unknown */
+        ...[0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF]
+    ]);
+    const payload = bytes.slice(4);
+    const body = new Uint8Array([
+        ...header,
+        ...payload
+    ]);
+    try {
+        var decompressed = new Uint8Array(lzma.decompress(body));
+    }
+    catch (error) {
+        throw new DecodeError(error, "LZMA decompression failed");
+    }
+    const dataLength = bytes.slice(3, 4);
+    if (dataLength[0] !== decompressed.length) {
+        throw new Error("The length of the data after decompression is not as expected.");
+    }
+    const _checksum = decompressed.slice(0, 4);
+    const decompressedBody = decompressed.slice(4);
+    const decoded = new TextDecoder("utf-8").decode(decompressedBody);
+    return deserialize(decoded);
 }
 exports.parse = parse;
 /**
@@ -160,24 +272,24 @@ exports.parse = parse;
 function detect(qr) {
     try {
         var parsed = rfc4648_1.base32hex.parse(qr, {
-            out: Buffer,
             loose: true
         });
     }
     catch {
-        throw new Error("Unable to parse QR string, invalid data");
+        throw new Error("Invalid data, Unable to decode base32hex QR string");
     }
     if (parsed.byteLength < 2) {
         return false;
     }
-    const headerBysquare = parsed.subarray(0, 2);
-    return [...headerBysquare.toString("hex")]
-        .map((nibble) => parseInt(nibble, 16))
+    const bysquareHeader = parsed.subarray(0, 2);
+    const { bysquareType, version, documentType, reserved } = bysquareHeaderDecoder(bysquareHeader);
+    const isValid = [bysquareType, version, documentType, reserved]
         .every((nibble, index) => {
-        if ( /** version */index === 1) {
-            return 0 >= nibble && nibble <= 1;
+        if (index === 1) {
+            return nibble <= 1 /* Version["1.1.0"] */;
         }
-        return 0 <= nibble && nibble <= 15;
+        return 0x00 <= nibble && nibble <= 0x0F;
     });
+    return isValid;
 }
 exports.detect = detect;

package/lib/cjs/types.d.ts

@@ -1,3 +1,21 @@
+/**
+ * Mapping semantic version to encoded version number, header 4-bits
+ *
+ * It's a bit silly to limit the version number to 4-bit, if they keep
+ * increasing the version number, the latest possible mapped value is 16
+ */
+export declare const enum Version {
+    /**
+     * 2013-02-22
+     * Created this document from original by square specifications
+     */
+    "1.0.0" = 0,
+    /**
+     * 2015-06-24
+     * Added fields for beneficiary name and address
+     */
+    "1.1.0" = 1
+}
 /**
  * Selection of one or more months on which payment occurs. This is enabled
  * only if periodicity is set to one of the following value: “Weekly,

package/lib/mjs/cli.js

@@ -3,52 +3,34 @@ import { existsSync, readFileSync } from "node:fs";
 import path from "node:path";
 import { createInterface } from "node:readline";
 import { generate } from "./generate.js";
-if (process.stdin.isTTY) {
-    // bysquare "file"
+if /** bysquare "file" */ (process.stdin.isTTY) {
     handleInput(process.argv[2]);
-}
+} /** bysquare <<< "data" */
 else {
-    // echo "data" | bysquare
     ;
     (async () => {
         const stdin = await handleStdin();
-        const qr = await fromJsonString(stdin).catch((e) => {
-            console.error(e);
-            process.exit(1);
-        });
-        console.log(qr);
+        console.log(fromJsonString(stdin));
         process.exit(0);
     })();
 }
-async function handleInput(input) {
+function handleInput(input) {
     if (input === undefined || input === "-h" || input === "--help") {
         console.log(help());
         process.exit(0);
     }
     if (existsSync(process.argv[2])) {
         const file = readFileSync(process.argv[2], "utf8");
-        const qr = await fromJsonString(file).catch((e) => {
-            console.error(e);
-            process.exit(1);
-        });
-        console.log(qr);
+        console.log(fromJsonString(file));
     }
     else {
         console.error(`File ${process.argv[2]} doesn't exists`);
         process.exit(1);
     }
 }
-async function fromJsonString(stdin) {
-    return new Promise((resolve, reject) => {
-        try {
-            const data = JSON.parse(stdin);
-            const qrString = generate(data);
-            resolve(qrString);
-        }
-        catch (e) {
-            reject(e);
-        }
-    });
+function fromJsonString(stdin) {
+    const data = JSON.parse(stdin);
+    return generate(data);
 }
 async function handleStdin() {
     const readline = createInterface({
@@ -85,18 +67,17 @@ function help() {
         "If <file> is omitted, reads from stdin.",
         "",
         "Examples:",
-        "   bysquare ./example.json",
-        "",
-        "   echo ",
-        "       {",
-        '           "IBAN": "SK9611000000002918599669"',
-        '           "Amount": 100.0',
-        '           "CurrencyCode": "EUR"',
-        '           "VariableSymbol": "123"',
-        '           "Payments": 1',
-        '           "PaymentOptions": 1',
-        '           "BankAccounts": 1',
-        "       }'",
-        "   | bysquare"
+        "	bysquare <<< \"{",
+        "		\"invoiceId\": \"random-id\",",
+        "		\"payments\": [",
+        "			{",
+        "				\"type\": 1,",
+        "				\"amount\": 100.0,",
+        "				\"bankAccounts\": [{ \"iban\": \"SK9611000000002918599669\" }],",
+        "				\"currencyCode\": \"EUR\",",
+        "				\"variableSymbol\": \"123\"",
+        "			}",
+        "		]",
+        "	}\""
     ].join("\n");
 }

package/lib/mjs/generate.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import { DataModel } from "./types.js";
 /**
  * Returns a 2 byte buffer that represents the header of the bysquare
@@ -13,36 +12,45 @@ import { DataModel } from "./types.js";
  * | Reserved     | 4              | 0-15            | bits reserved for future needs
  * ```
  *
- * @see 3.5. by square header
+ * @see 3.5.
  */
-export declare function bysquareHeader(header?: [
+export declare function headerBysquare(
+/** dprint-ignore */
+header?: [
     bySquareType: number,
     version: number,
     documentType: number,
     reserved: number
-]): Buffer;
+]): Uint8Array;
 /**
- * @see 3.10 Appending CRC32 checksum
+ * Creates a one-byte array that represents the length of compressed data in
+ * combination with CRC32 in bytes.
  */
-export declare function checksum(intermediate: string): Buffer;
+export declare function headerDataLength(length: number): Uint8Array;
 /**
  * Transfer object to a tabbed string and append a CRC32 checksum
  *
- * @see 3.10. Appending CRC32 checksum
+ * @see 3.10.
  */
-export declare function prepareCompression(model: DataModel): Buffer;
+export declare function addChecksum(serialized: string): Uint8Array;
 /**
  * Transform data to ordered tab-separated intermediate representation ready for
  * encoding
  *
- * @see Table 15 PAY by square sequence data model
+ * @see Table 15.
  */
-export declare function toIntermediate(data: DataModel): string;
+export declare function serialize(data: DataModel): string;
 type Options = {
+    /**
+     * Many banking apps do not support diacritics, which results in errors when
+     * serializing data from QR codes.
+     *
+     * @default true
+     */
     deburr: boolean;
 };
 /**
  * Generate QR string ready for encoding into text QR code
  */
-export declare function generate(model: DataModel, options?: Options): Promise<string>;
+export declare function generate(model: DataModel, options?: Options): string;
 export {};