bysquare 2.2.0 → 2.3.0

package/README.md

@@ -110,26 +110,6 @@ const model =
 // 	]
 // }
 //
-const qr =
-	"0004A00090IFU27IV0J6HGGLIOTIBVHNQQJQ6LAVGNBT363HR13JC6CB54HSI0KH9FCRASHNQBSKAQD2LJ4AU400UVKDNDPFRKLOBEVVVU0QJ000"
-
-const model = parse(qr)
-/**
- *  {
- * 	invoiceId: "random-id",
- * 	payments: [
- * 		{
- * 			type: PaymentOptions.PaymentOrder,
- * 			amount: 100.0,
- * 			bankAccounts: [
- * 				{ iban: "SK9611000000002918599669" },
- * 			],
- * 			currencyCode: "EUR",
- * 			variableSymbol: "123",
- * 		}
- * 	]
- * }
- */
 ```
 
 You can use json file with valid model to generate qr-string.

package/lib/cjs/generate.js

@@ -1,27 +1,4 @@
 "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 };
 };
@@ -29,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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 = __importStar(require("lzma1"));
+const lzma1_1 = require("lzma1");
 const rfc4648_1 = require("rfc4648");
 const types_js_1 = require("./types.js");
 /**
@@ -66,33 +43,16 @@ header = [
     return mergedNibbles;
 }
 exports.headerBysquare = headerBysquare;
-/**
- * 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.
- */
-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);
-}
 /**
  * Creates a one-byte array that represents the length of compressed data in
  * combination with CRC32 in bytes.
  */
 function headerDataLength(length) {
-    if (length >= 2 ** 16) {
+    if (length >= 131072 /** 2^17 */) {
         throw new Error("The maximum compressed data size has been reached");
     }
-    const header = new ArrayBuffer(1);
-    new DataView(header).setUint8(0, length);
+    const header = new ArrayBuffer(2);
+    new DataView(header).setUint16(0, length);
     return new Uint8Array(header);
 }
 exports.headerDataLength = headerDataLength;
@@ -196,15 +156,17 @@ function generate(model, options = { deburr: true }) {
     }
     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 compressed = Uint8Array.from((0, lzma1_1.compress)(withChecksum));
+    const _lzmaHeader = Uint8Array.from(compressed.subarray(0, 13));
+    const lzmaBody = Uint8Array.from(compressed.subarray(13));
     const output = Uint8Array.from([
-        ...headerBysquare([0x00, 1 /* Version["1.1.0"] */, 0x00, 0x00]),
-        ...headerLzmaProps(),
+        // FIXME:
+        // for now other implementation of bysquare doesn't recognize header if
+        // version is specified like TatraBanka
+        // ...headerBysquare([0x00, Version["1.1.0"], 0x00, 0x00]),
+        ...headerBysquare([0x00, 0x00, 0x00, 0x00]),
         ...headerDataLength(withChecksum.byteLength),
-        ...compressedPayload
+        ...lzmaBody
     ]);
     return rfc4648_1.base32hex.stringify(output, {
         pad: false

package/lib/cjs/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": "2.2.0",
+  "version": "2.3.0",
   "license": "Apache-2.0",
   "funding": "https://github.com/sponsors/xseman",
   "homepage": "https://github.com/xseman/bysquare#readme",

package/lib/cjs/parse.js

@@ -1,30 +1,7 @@
 "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.parse = exports.DecodeError = exports.deserialize = void 0;
-const lzma = __importStar(require("lzma1"));
+const lzma1_1 = require("lzma1");
 const rfc4648_1 = require("rfc4648");
 const index_js_1 = require("./index.js");
 function cleanEmptyProps(obj) {
@@ -155,24 +132,6 @@ function deserialize(qr) {
     return output;
 }
 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);
-}
 /**
  * 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
@@ -183,9 +142,9 @@ function calcLzmaDictionarySize(props) {
 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;
+    const version = (bytes >> 8) & 15;
+    const documentType = (bytes >> 4) & 15;
+    const reserved = bytes & 15;
     return {
         bysquareType,
         version,
@@ -217,8 +176,7 @@ function parse(qr) {
         throw new DecodeError(error, "Unable to decode QR string base32hex encoding");
     }
     const bysquareHeader = bytes.slice(0, 2);
-    const { version } = bysquareHeaderDecoder(bysquareHeader);
-    if ((version > 1 /* Version["1.1.0"] */)) {
+    if ((bysquareHeaderDecoder(bysquareHeader).version > 1 /* Version["1.1.0"] */)) {
         throw new Error("Unsupported Bysquare version");
     }
     /**
@@ -233,14 +191,16 @@ function parse(qr) {
      * | Properties |  Dictionary Size  |   Uncompressed Size   |
      * +------------+----+----+----+----+--+--+--+--+--+--+--+--+
      */
-    const lzmaProperties = bytes.slice(2, 3);
-    const decodedProps = LzmaPropertiesDecoder(lzmaProperties);
-    const dictSize = calcLzmaDictionarySize(decodedProps);
+    const defaultProperties = [0x5D]; // lc=3, lp=0, pb=2
+    const defaultDictionarySize = [0x00, 0x02, 0x00, 0x00]; // 2^17
+    const dataLengthView = new DataView(bytes.slice(2, 4).buffer);
+    const dataLength = dataLengthView.getUint16(0);
+    const uncompressedSize = new ArrayBuffer(8);
+    new DataView(uncompressedSize).setBigUint64(0, BigInt(dataLength), true);
     const header = new Uint8Array([
-        lzmaProperties[0],
-        ...dictSize,
-        /** Uncompressed size, this value indicates that size is unknown */
-        ...[0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF]
+        ...defaultProperties,
+        ...defaultDictionarySize,
+        ...new Uint8Array(uncompressedSize)
     ]);
     const payload = bytes.slice(4);
     const body = new Uint8Array([
@@ -248,15 +208,11 @@ function parse(qr) {
         ...payload
     ]);
     try {
-        var decompressed = new Uint8Array(lzma.decompress(body));
+        var decompressed = new Uint8Array((0, lzma1_1.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);

package/lib/mjs/generate.js

@@ -1,6 +1,6 @@
 import crc32 from "crc-32";
 import deburr from "lodash.deburr";
-import * as lzma from "lzma1";
+import { compress } from "lzma1";
 import { base32hex } from "rfc4648";
 import { PaymentOptions } from "./types.js";
 /**
@@ -36,33 +36,16 @@ header = [
     ]);
     return mergedNibbles;
 }
-/**
- * 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.
- */
-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);
-}
 /**
  * Creates a one-byte array that represents the length of compressed data in
  * combination with CRC32 in bytes.
  */
 export function headerDataLength(length) {
-    if (length >= 2 ** 16) {
+    if (length >= 131072 /** 2^17 */) {
         throw new Error("The maximum compressed data size has been reached");
     }
-    const header = new ArrayBuffer(1);
-    new DataView(header).setUint8(0, length);
+    const header = new ArrayBuffer(2);
+    new DataView(header).setUint16(0, length);
     return new Uint8Array(header);
 }
 /**
@@ -163,15 +146,17 @@ export function generate(model, options = { deburr: true }) {
     }
     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 compressed = Uint8Array.from(compress(withChecksum));
+    const _lzmaHeader = Uint8Array.from(compressed.subarray(0, 13));
+    const lzmaBody = Uint8Array.from(compressed.subarray(13));
     const output = Uint8Array.from([
-        ...headerBysquare([0x00, 1 /* Version["1.1.0"] */, 0x00, 0x00]),
-        ...headerLzmaProps(),
+        // FIXME:
+        // for now other implementation of bysquare doesn't recognize header if
+        // version is specified like TatraBanka
+        // ...headerBysquare([0x00, Version["1.1.0"], 0x00, 0x00]),
+        ...headerBysquare([0x00, 0x00, 0x00, 0x00]),
         ...headerDataLength(withChecksum.byteLength),
-        ...compressedPayload
+        ...lzmaBody
     ]);
     return base32hex.stringify(output, {
         pad: false

package/lib/mjs/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": "2.2.0",
+	"version": "2.3.0",
 	"license": "Apache-2.0",
 	"funding": "https://github.com/sponsors/xseman",
 	"homepage": "https://github.com/xseman/bysquare#readme",

package/lib/mjs/parse.js

@@ -1,4 +1,4 @@
-import * as lzma from "lzma1";
+import { decompress } from "lzma1";
 import { base32hex } from "rfc4648";
 import { PaymentOptions } from "./index.js";
 function cleanEmptyProps(obj) {
@@ -128,24 +128,6 @@ export function deserialize(qr) {
     }
     return output;
 }
-/**
- * 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);
-}
 /**
  * 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
@@ -156,9 +138,9 @@ function calcLzmaDictionarySize(props) {
 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;
+    const version = (bytes >> 8) & 15;
+    const documentType = (bytes >> 4) & 15;
+    const reserved = bytes & 15;
     return {
         bysquareType,
         version,
@@ -189,8 +171,7 @@ export function parse(qr) {
         throw new DecodeError(error, "Unable to decode QR string base32hex encoding");
     }
     const bysquareHeader = bytes.slice(0, 2);
-    const { version } = bysquareHeaderDecoder(bysquareHeader);
-    if ((version > 1 /* Version["1.1.0"] */)) {
+    if ((bysquareHeaderDecoder(bysquareHeader).version > 1 /* Version["1.1.0"] */)) {
         throw new Error("Unsupported Bysquare version");
     }
     /**
@@ -205,14 +186,16 @@ export function parse(qr) {
      * | Properties |  Dictionary Size  |   Uncompressed Size   |
      * +------------+----+----+----+----+--+--+--+--+--+--+--+--+
      */
-    const lzmaProperties = bytes.slice(2, 3);
-    const decodedProps = LzmaPropertiesDecoder(lzmaProperties);
-    const dictSize = calcLzmaDictionarySize(decodedProps);
+    const defaultProperties = [0x5D]; // lc=3, lp=0, pb=2
+    const defaultDictionarySize = [0x00, 0x02, 0x00, 0x00]; // 2^17
+    const dataLengthView = new DataView(bytes.slice(2, 4).buffer);
+    const dataLength = dataLengthView.getUint16(0);
+    const uncompressedSize = new ArrayBuffer(8);
+    new DataView(uncompressedSize).setBigUint64(0, BigInt(dataLength), true);
     const header = new Uint8Array([
-        lzmaProperties[0],
-        ...dictSize,
-        /** Uncompressed size, this value indicates that size is unknown */
-        ...[0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF]
+        ...defaultProperties,
+        ...defaultDictionarySize,
+        ...new Uint8Array(uncompressedSize)
     ]);
     const payload = bytes.slice(4);
     const body = new Uint8Array([
@@ -220,15 +203,11 @@ export function parse(qr) {
         ...payload
     ]);
     try {
-        var decompressed = new Uint8Array(lzma.decompress(body));
+        var decompressed = new Uint8Array(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);

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": "2.2.0",
+	"version": "2.3.0",
 	"license": "Apache-2.0",
 	"funding": "https://github.com/sponsors/xseman",
 	"homepage": "https://github.com/xseman/bysquare#readme",