bysquare 2.0.1 → 2.2.0

package/lib/cjs/generate.js

@@ -1,14 +1,37 @@
 "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;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generate = exports.toIntermediate = exports.prepareCompression = exports.checksum = exports.bysquareHeader = void 0;
+exports.generate = exports.serialize = exports.addChecksum = exports.headerDataLength = exports.headerBysquare = void 0;
+const crc_32_1 = __importDefault(require("crc-32"));
 const lodash_deburr_1 = __importDefault(require("lodash.deburr"));
-const lzma_native_1 = __importDefault(require("lzma-native"));
+const lzma = __importStar(require("lzma1"));
 const rfc4648_1 = require("rfc4648");
 const types_js_1 = require("./types.js");
-// echo "Hello" | xz --format=raw --lzma1=lc=3,lp=0,pb=2,dict=32KiB --stdout | hexdump -C
 /**
  * Returns a 2 byte buffer that represents the header of the bysquare
  * specification
@@ -22,129 +45,132 @@ const types_js_1 = require("./types.js");
  * | Reserved     | 4              | 0-15            | bits reserved for future needs
  * ```
  *
- * @see 3.5. by square header
+ * @see 3.5.
  */
-function bysquareHeader(header = [
-    0, 0,
-    0, 0
+function headerBysquare(
+/** dprint-ignore */
+header = [
+    0x00, 0x00,
+    0x00, 0x00
 ]) {
     const isValid = header.every((nibble) => 0 <= nibble && nibble <= 15);
     if (!isValid) {
-        throw new Error(`Invalid header byte value, valid range <0,15>`);
+        throw new Error("Invalid header byte value, valid range <0,15>");
     }
     const [bySquareType, version, documentType, reserved] = header;
     // Combine 4-nibbles to 2-bytes
-    const mergedNibbles = Buffer.from([
+    const mergedNibbles = Uint8Array.from([
         (bySquareType << 4) | (version << 0),
-        (documentType << 4) | (reserved << 0),
+        (documentType << 4) | (reserved << 0)
     ]);
     return mergedNibbles;
 }
-exports.bysquareHeader = bysquareHeader;
+exports.headerBysquare = headerBysquare;
 /**
- * Allocates a new buffer of a 2 bytes that represents LZMA header which
- * contains 16-bit unsigned integer (word, little-endian), which is the size of
- * the decompressed data. Therefore the maximum size of compressed data is
- * limited to 65535
+ * The function first sets default values for the lc, lp, and pb properties,
+ * which represent the number of literal context bits, literal position bits,
+ * and position bits, respectively. These values are then used to calculate the
+ * properties value, which is a single byte that encodes all three properties.
  *
- * @see 3.11. LZMA Compression
+ * @see 3.11.
  */
-function lzmaHeader(decompressedData) {
-    const bytesCount = decompressedData.length;
-    if (bytesCount >= 2 ** 16) {
-        throw new Error("The maximum compressed data size has been reached");
-    }
-    const dataSize = Buffer.alloc(2);
-    dataSize.writeInt16LE(bytesCount);
-    return dataSize;
+function headerLzmaProps() {
+    const lc = 3;
+    const lp = 0;
+    const pb = 2;
+    const properties = (((pb * 5) + lp) * 9) + lc;
+    const header = new ArrayBuffer(1);
+    new DataView(header).setUint8(0, properties);
+    return new Uint8Array(header);
 }
 /**
- * @see 3.10 Appending CRC32 checksum
+ * Creates a one-byte array that represents the length of compressed data in
+ * combination with CRC32 in bytes.
  */
-function checksum(intermediate) {
-    // @ts-ignore: Wrong return type
-    const data = lzma_native_1.default.crc32(intermediate);
-    const crc32 = Buffer.alloc(4);
-    crc32.writeUInt32LE(data);
-    return crc32;
+function headerDataLength(length) {
+    if (length >= 2 ** 16) {
+        throw new Error("The maximum compressed data size has been reached");
+    }
+    const header = new ArrayBuffer(1);
+    new DataView(header).setUint8(0, length);
+    return new Uint8Array(header);
 }
-exports.checksum = checksum;
+exports.headerDataLength = headerDataLength;
 /**
  * Transfer object to a tabbed string and append a CRC32 checksum
  *
- * @see 3.10. Appending CRC32 checksum
+ * @see 3.10.
  */
-function prepareCompression(model) {
-    const intermediate = toIntermediate(model);
-    return Buffer.concat([
-        checksum(intermediate),
-        Buffer.from(intermediate, "utf-8")
+function addChecksum(serialized) {
+    const checksum = new ArrayBuffer(4);
+    new DataView(checksum).setUint32(0, crc_32_1.default.str(serialized), true);
+    const byteArray = new TextEncoder().encode(serialized);
+    return Uint8Array.from([
+        ...new Uint8Array(checksum),
+        ...Uint8Array.from(byteArray)
     ]);
 }
-exports.prepareCompression = prepareCompression;
+exports.addChecksum = addChecksum;
 /**
  * Transform data to ordered tab-separated intermediate representation ready for
  * encoding
  *
- * @see Table 15 PAY by square sequence data model
+ * @see Table 15.
  */
-function toIntermediate(data) {
-    const intermediate = new Array();
-    intermediate.push(data.invoiceId?.toString());
-    intermediate.push(data.payments.length.toString());
+function serialize(data) {
+    const serialized = new Array();
+    serialized.push(data.invoiceId?.toString());
+    serialized.push(data.payments.length.toString());
     for (const p of data.payments) {
-        intermediate.push(p.type.toString());
-        intermediate.push(p.amount?.toString());
-        intermediate.push(p.currencyCode);
-        intermediate.push(p.paymentDueDate);
-        intermediate.push(p.variableSymbol);
-        intermediate.push(p.constantSymbol);
-        intermediate.push(p.specificSymbol);
-        intermediate.push(p.originatorRefInfo);
-        intermediate.push(p.paymentNote);
-        intermediate.push(p.bankAccounts.length.toString());
+        serialized.push(p.type.toString());
+        serialized.push(p.amount?.toString());
+        serialized.push(p.currencyCode);
+        serialized.push(p.paymentDueDate);
+        serialized.push(p.variableSymbol);
+        serialized.push(p.constantSymbol);
+        serialized.push(p.specificSymbol);
+        serialized.push(p.originatorRefInfo);
+        serialized.push(p.paymentNote);
+        serialized.push(p.bankAccounts.length.toString());
         for (const ba of p.bankAccounts) {
-            intermediate.push(ba.iban);
-            intermediate.push(ba.bic);
+            serialized.push(ba.iban);
+            serialized.push(ba.bic);
         }
         if (p.type === types_js_1.PaymentOptions.StandingOrder) {
-            intermediate.push('1');
-            intermediate.push(p.day?.toString());
-            intermediate.push(p.month?.toString());
-            intermediate.push(p.periodicity);
-            intermediate.push(p.lastDate);
+            serialized.push("1");
+            serialized.push(p.day?.toString());
+            serialized.push(p.month?.toString());
+            serialized.push(p.periodicity);
+            serialized.push(p.lastDate);
         }
         else {
-            intermediate.push('0');
+            serialized.push("0");
         }
         if (p.type === types_js_1.PaymentOptions.DirectDebit) {
-            intermediate.push('1');
-            intermediate.push(p.directDebitScheme?.toString());
-            intermediate.push(p.directDebitType?.toString());
-            intermediate.push(p.variableSymbol?.toString());
-            intermediate.push(p.specificSymbol?.toString());
-            intermediate.push(p.originatorRefInfo?.toString());
-            intermediate.push(p.mandateId?.toString());
-            intermediate.push(p.creditorId?.toString());
-            intermediate.push(p.contractId?.toString());
-            intermediate.push(p.maxAmount?.toString());
-            intermediate.push(p.validTillDate?.toString());
+            serialized.push("1");
+            serialized.push(p.directDebitScheme?.toString());
+            serialized.push(p.directDebitType?.toString());
+            serialized.push(p.variableSymbol?.toString());
+            serialized.push(p.specificSymbol?.toString());
+            serialized.push(p.originatorRefInfo?.toString());
+            serialized.push(p.mandateId?.toString());
+            serialized.push(p.creditorId?.toString());
+            serialized.push(p.contractId?.toString());
+            serialized.push(p.maxAmount?.toString());
+            serialized.push(p.validTillDate?.toString());
         }
         else {
-            intermediate.push('0');
+            serialized.push("0");
         }
     }
     for (const p of data.payments) {
-        intermediate.push(p.beneficiary?.name);
-        intermediate.push(p.beneficiary?.street);
-        intermediate.push(p.beneficiary?.city);
+        serialized.push(p.beneficiary?.name);
+        serialized.push(p.beneficiary?.street);
+        serialized.push(p.beneficiary?.city);
     }
-    return intermediate.join('\t');
+    return serialized.join("\t");
 }
-exports.toIntermediate = toIntermediate;
-/**
- * Transfer diacritics to basic latin letters
- */
+exports.serialize = serialize;
 function removeDiacritics(model) {
     for (const payment of model.payments) {
         if (payment.paymentNote) {
@@ -168,40 +194,20 @@ function generate(model, options = { deburr: true }) {
     if (options.deburr) {
         removeDiacritics(model);
     }
-    const data = prepareCompression(model);
-    const compressedData = [];
-    return new Promise((resolve, reject) => {
-        const encoder = lzma_native_1.default.createStream("rawEncoder", {
-            synchronous: true,
-            // @ts-ignore: Missing filter types
-            filters: [
-                {
-                    // @ts-ignore: Missing filter types
-                    id: lzma_native_1.default.FILTER_LZMA1,
-                    lc: 3,
-                    lp: 0,
-                    pb: 2,
-                    dict_size: 2 ** 17, // 128 kilobytes
-                },
-            ],
-        });
-        encoder
-            .on("end", () => {
-            const output = Buffer.concat([
-                bysquareHeader(),
-                lzmaHeader(data),
-                ...compressedData
-            ]);
-            resolve(rfc4648_1.base32hex.stringify(output, { pad: false }));
-        })
-            .on("data", (chunk) => {
-            compressedData.push(chunk);
-        })
-            .on("error", reject)
-            .write(data, (error) => {
-            error && reject(error);
-            encoder.end();
-        });
+    const payload = serialize(model);
+    const withChecksum = addChecksum(payload);
+    const compressed = Uint8Array.from(lzma.compress(withChecksum));
+    /** Exclude the LZMA header and retain raw compressed data */
+    const _headerLzma = Uint8Array.from(compressed.subarray(0, 13));
+    const compressedPayload = Uint8Array.from(compressed.subarray(13));
+    const output = Uint8Array.from([
+        ...headerBysquare([0x00, 1 /* Version["1.1.0"] */, 0x00, 0x00]),
+        ...headerLzmaProps(),
+        ...headerDataLength(withChecksum.byteLength),
+        ...compressedPayload
+    ]);
+    return rfc4648_1.base32hex.stringify(output, {
+        pad: false
     });
 }
 exports.generate = generate;

package/lib/cjs/package.json

@@ -1,18 +1,29 @@
 {
   "name": "bysquare",
   "description": "It's a national standard for payment QR codes adopted by Slovak Banking Association (SBA)",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "license": "Apache-2.0",
-  "type": "commonjs",
   "funding": "https://github.com/sponsors/xseman",
   "homepage": "https://github.com/xseman/bysquare#readme",
-  "author": {
-    "name": "Filip Seman",
-    "email": "filip.seman@protonmail.com"
+  "author": "Filip Seman <filip.seman@pm.me>",
+  "keywords": [
+    "pay by square",
+    "by square",
+    "paybysquare",
+    "bysquare",
+    "payments",
+    "qr-string",
+    "generate",
+    "parse"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xseman/bysquare.git"
   },
   "scripts": {
     "prebuild": "rm -rf ./lib || :",
     "build": "tsc --project ./tsconfig.json && tsc --project ./tsconfig.cjs.json",
+    "typecheck": "tsc --noEmit",
     "postbuild": "bash -c 'chmod +x ./lib/{cjs,mjs}/cli.js' && cp package.json ./lib/mjs/ && jq '.type=\"commonjs\"' package.json > lib/cjs/package.json",
     "test": "xv --loader=tsx ./src",
     "test:watch": "find ./src/*.ts | entr xv --loader=tsx ./src",
@@ -24,18 +35,20 @@
     "postversion": ""
   },
   "dependencies": {
+    "crc-32": "~1.2.0",
     "lodash.deburr": "~4.1.0",
-    "lzma-native": "7.0.1",
-    "rfc4648": "1.5.2"
+    "lzma1": "~0.0.1",
+    "rfc4648": "~1.5.0"
   },
   "devDependencies": {
     "@types/lodash.deburr": "~4.1.0",
-    "@types/lzma-native": "^4.0.1",
-    "@types/node": "~18.11.0",
+    "@types/node": ">=16.14",
+    "dprint": "~0.35.0",
     "tsx": "~3.12.0",
-    "typescript": "~4.9.0",
+    "typescript": "~5.0.0",
     "xv": "~2.1.0"
   },
+  "type": "commonjs",
   "bin": "lib/mjs/cli.js",
   "types": "lib/mjs/index.d.ts",
   "exports": {
@@ -49,21 +62,7 @@
     "!lib/*.test.*"
   ],
   "engines": {
-    "node": ">=16.0",
+    "node": ">=16.14",
     "npm": ">=7.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/xseman/bysquare.git"
-  },
-  "keywords": [
-    "pay by square",
-    "by square",
-    "paybysquare",
-    "bysquare",
-    "payments",
-    "qr-string",
-    "qr",
-    "cli"
-  ]
+  }
 }

package/lib/cjs/parse.d.ts

@@ -1,12 +1,21 @@
 import { DataModel } from "./index.js";
 /**
- * @see 3.14. Generating by square Code
+ * Generating by square Code
+ *
+ * @see 3.14.
  */
-export declare function buildModel(qr: string): DataModel;
+export declare function deserialize(qr: string): DataModel;
+export declare class DecodeError extends Error {
+    cause: Error;
+    name: string;
+    constructor(cause: Error, msg?: string);
+}
 /**
- * @see 3.16. Decoding client data from QR Code 2005 symbol
+ * Decoding client data from QR Code 2005 symbol
+ *
+ * @see 3.16.
  */
-export declare function parse(qr: string): Promise<DataModel>;
+export declare function parse(qr: string): DataModel;
 /**
  * Detect if qr string contains bysquare header.
  *