bysquare 2.8.0 → 2.8.2

package/README.md

@@ -1,8 +1,5 @@
 # bysquare
 
-![version][version]
-![build][build]
-
 Simple JavaScript library to encode and decode "PAY by square" string.
 
 **What is `PAY by square`?**
@@ -17,55 +14,58 @@ This library doesn't have a specific opinion and how the QR code string is
 transformed into images depends on how you implement it. See
 [examples](./docs/examples/).
 
-## Install
+## Features
+
+- Encode data to qr string
+- Decode data to json
+- Detect bysquare from qr string
+
+## Installation
 
 **NOTE**: This package is native [ESM][mozzila-esm] and no longer provides a
 CommonJS export. If your project uses CommonJS, you will have to convert to ESM
 or use the dynamic [`import()`][mozzila-import] function.
 
-**npm registry**
+[mozzila-esm]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+[mozzila-import]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import
+
+### npm registry
 
 ```sh
 npm install bysquare
 ```
 
-**Browser**
+### CLI Node `v18+`
 
-```html
-<script type="module">
-	import { encode, decode } from "https://esm.sh/bysquare@2.7.1/";
-</script>
+```sh
+npm install --global bysquare
 ```
 
-**Deno** `v1.28+` using npm prefix
+### deno
+
+Since `v1.28+` import from npm registry using `npm:` prefix.
 
 ```ts
-import { encode, decode } from "npm:bysquare@2.7.1";
+import { decode, encode } from "npm:bysquare@2.8.0";
 ```
 
-**CLI** (Node.JS `v18`+)
+### Browser
 
-```sh
-npm install --global bysquare
+```html
+<script type="module">
+	import { encode, decode } from "https://esm.sh/bysquare@2.8.0/";
+</script>
 ```
 
-# How it works
+## How it works
 
-## Encoding sequence
+### Encoding sequence
 
 ![logic](./docs/uml/logic.svg)
 
-# API
-
-```ts
-encode(model: DataModel, options?: Options): string
-decode(qr: string): DataModel
-detect(qr: string): Boolean
-```
-
-# Usage
+## Usage
 
-## Encode
+### Encode
 
 ```ts
 import { CurrencyCode, DataModel, encode, PaymentOptions } from "bysquare";
@@ -89,13 +89,13 @@ const qrString = encode({
 });
 ```
 
-## Decode
+### Decode
 
 ```ts
 import { decode } from "bysquare";
 
 const model = decode(
-	"0405QH8090IFU27IV0J6HGGLIOTIBVHNQQJQ6LAVGNBT363HR13JC6CB54HSI0KH9FCRASHNQBSKAQD2LJ4AU400UVKDNDPFRKLOBEVVVU0QJ000"
+	"0405QH8090IFU27IV0J6HGGLIOTIBVHNQQJQ6LAVGNBT363HR13JC6CB54HSI0KH9FCRASHNQBSKAQD2LJ4AU400UVKDNDPFRKLOBEVVVU0QJ000",
 );
 
 // {
@@ -115,9 +115,9 @@ const model = decode(
 //
 ```
 
-# CLI
+## CLI
 
-## Encode
+### Encode
 
 Encode JSON or JSONL data from files and print the corresponding QR code.
 
@@ -126,7 +126,7 @@ npx bysquare --encode file1.json file2.json...
 npx bysquare --encode file.jsonl
 ```
 
-## Decode
+### Decode
 
 Decode the specified QR code string and print the corresponding JSON data. The
 qrstring argument should be a valid QR code string.
@@ -135,16 +135,31 @@ qrstring argument should be a valid QR code string.
 npx bysquare --decode <qrstring>
 ```
 
-## Related
+## Platform support
 
--   <https://bysquare.com/>
--   <https://devel.cz/otazka/qr-kod-pay-by-square>
--   <https://github.com/matusf/pay-by-square>
--   <https://www.bsqr.co/schema/>
--   <https://www.sbaonline.sk/wp-content/uploads/2020/03/pay-by-square-specifications-1_1_0.pdf>
--   <https://www.vutbr.cz/studenti/zav-prace/detail/78439>
+I mainly focus on LTS versions of Node.js and try to use the most idiomatic
+ECMAScript possible to avoid specific runtime coupling.
 
-[build]: https://img.shields.io/github/actions/workflow/status/xseman/bysquare/tests.yml
-[version]: https://img.shields.io/npm/v/bysquare
-[mozzila-esm]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
-[mozzila-import]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import
+This doesn't mean that the library won't work on older versions, but it might
+not be as reliable.
+
+As of `v1.28`, Deno now includes built-in support for npm modules and is ready
+to use without additional setup, showing its improved maturity.
+
+### Node.js & Deno
+
+- Node.js `v18` and later.
+- Deno `v1.28` and later.
+
+### Browser
+
+The latest version of Chrome, Firefox, and Safari.
+
+## Related
+
+- <https://bysquare.com/>
+- <https://devel.cz/otazka/qr-kod-pay-by-square>
+- <https://github.com/matusf/pay-by-square>
+- <https://www.bsqr.co/schema/>
+- <https://www.sbaonline.sk/wp-content/uploads/2020/03/pay-by-square-specifications-1_1_0.pdf>
+- <https://www.vutbr.cz/studenti/zav-prace/detail/78439>

package/dist/cli.js

@@ -1,25 +1,25 @@
 #!/usr/bin/env node
 import { existsSync, readFileSync } from "node:fs";
-import { parseArgs } from "node:util";
 import process from "node:process";
-import { encode } from "./encode.js";
+import { parseArgs } from "node:util";
 import { decode } from "./decode.js";
+import { encode } from "./encode.js";
 const args = parseArgs({
     allowPositionals: true,
     options: {
         decode: {
             type: "string",
-            short: "d"
+            short: "d",
         },
         encode: {
             type: "boolean",
-            short: "e"
+            short: "e",
         },
         help: {
             type: "boolean",
-            short: "h"
-        }
-    }
+            short: "h",
+        },
+    },
 });
 if (process.stdin.isTTY) {
     if (args.values.encode) {
@@ -32,14 +32,14 @@ if (process.stdin.isTTY) {
                 console.error(`File ${file} doesn't exist`);
                 process.exit(1);
             }
-            if (file.endsWith(".json") === false &&
-                file.endsWith(".jsonl") === false) {
+            if (file.endsWith(".json") === false
+                && file.endsWith(".jsonl") === false) {
                 console.error(`Unsupported file format for ${file}`);
                 process.exit(1);
             }
             const data = readFileSync(file, "utf8");
             if (file.endsWith(".jsonl")) {
-                const lines = data.split('\n');
+                const lines = data.split("\n");
                 for (const line of lines) {
                     if (!line)
                         continue;
@@ -58,8 +58,8 @@ if (process.stdin.isTTY) {
         console.log(JSON.stringify(decode(qrstring), null, 4));
         process.exit(0);
     }
-    if (args.values.help ||
-        Object.keys(args.values).length === 0) {
+    if (args.values.help
+        || Object.keys(args.values).length === 0) {
         console.log([
             "NAME",
             "	bysquare - Simple Node.js library to generate and parse PAY bysquare standard",
@@ -96,7 +96,7 @@ if (process.stdin.isTTY) {
             `	${process.argv[1]} --decode <qrstring>`,
             "	Replace qrstring with the QR code string you want to decode.",
             "	The program will parse the QR code string and print the resulting JSON data.",
-            ""
+            "",
         ].join("\n"));
     }
 }

package/dist/decode.d.ts

@@ -16,7 +16,6 @@ export declare const parse: typeof decode;
  * Decoding client data from QR Code 2005 symbol
  *
  * @see 3.16.
- *
  */
 export declare function decode(qr: string): DataModel;
 /**

package/dist/decode.js

@@ -1,6 +1,6 @@
 import { decompress } from "lzma1";
 import { base32hex } from "rfc4648";
-import { PaymentOptions } from "./index.js";
+import { CurrencyCode, PaymentOptions, Version, } from "./index.js";
 function cleanUndefined(obj) {
     Object.keys(obj).forEach((key) => {
         if (typeof obj[key] === "undefined") {
@@ -14,27 +14,27 @@ function cleanUndefined(obj) {
  * @see 3.14.
  */
 export function deserialize(qr) {
-    const serialized = qr.split("\t");
-    const invoiceId = serialized.shift();
+    const data = qr.split("\t");
+    const invoiceId = data.shift();
     const output = {
         invoiceId: invoiceId?.length ? invoiceId : undefined,
-        payments: []
+        payments: new Array(),
     };
-    const paymentslen = Number(serialized.shift());
+    const paymentslen = Number(data.shift());
     for (let i = 0; i < paymentslen; i++) {
-        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();
+        const paymentOptions = data.shift();
+        const ammount = data.shift();
+        const currency = data.shift();
+        const dueDate = data.shift();
+        const variables = data.shift();
+        const constants = data.shift();
+        const specifics = data.shift();
+        const originatorRefInfo = data.shift();
+        const paymentNote = data.shift();
         let payment = {
             bankAccounts: [],
             type: Number(paymentOptions),
-            currencyCode: currency,
+            currencyCode: currency ?? CurrencyCode.EUR,
             amount: ammount?.length
                 ? Number(ammount)
                 : undefined,
@@ -55,26 +55,26 @@ export function deserialize(qr) {
                 : undefined,
             paymentNote: paymentNote?.length
                 ? paymentNote
-                : undefined
+                : undefined,
         };
-        const accountslen = Number(serialized.shift());
+        const accountslen = Number(data.shift());
         for (let j = 0; j < accountslen; j++) {
-            const iban = serialized.shift();
+            const iban = data.shift();
             if (iban === undefined || iban.length === 0) {
                 throw new Error("Missing IBAN");
             }
-            const bic = serialized.shift();
+            const bic = data.shift();
             const account = {
                 iban: iban,
                 bic: bic?.length
                     ? bic
-                    : undefined
+                    : undefined,
             };
             cleanUndefined(account);
             payment.bankAccounts.push(account);
         }
-        serialized.shift(); // StandingOrderExt
-        serialized.shift(); // DirectDebitExt
+        data.shift(); // StandingOrderExt
+        data.shift(); // DirectDebitExt
         // narrowing payment type
         switch (payment.type) {
             case PaymentOptions.PaymentOrder:
@@ -82,22 +82,22 @@ export function deserialize(qr) {
             case PaymentOptions.StandingOrder:
                 payment = {
                     ...payment,
-                    day: Number(serialized.shift()),
-                    month: Number(serialized.shift()),
-                    periodicity: serialized.shift(),
-                    lastDate: serialized.shift()
+                    day: Number(data.shift()),
+                    month: Number(data.shift()),
+                    periodicity: data.shift(),
+                    lastDate: data.shift(),
                 };
                 break;
             case PaymentOptions.DirectDebit:
                 payment = {
                     ...payment,
-                    directDebitScheme: Number(serialized.shift()),
-                    directDebitType: Number(serialized.shift()),
-                    mandateId: serialized.shift(),
-                    creditorId: serialized.shift(),
-                    contractId: serialized.shift(),
-                    maxAmount: Number(serialized.shift()),
-                    validTillDate: serialized.shift()
+                    directDebitScheme: Number(data.shift()),
+                    directDebitType: Number(data.shift()),
+                    mandateId: data.shift(),
+                    creditorId: data.shift(),
+                    contractId: data.shift(),
+                    maxAmount: Number(data.shift()),
+                    validTillDate: data.shift(),
                 };
                 break;
             default:
@@ -107,9 +107,9 @@ export function deserialize(qr) {
         output.payments.push(payment);
     }
     for (let i = 0; i < paymentslen; i++) {
-        const name = serialized.shift();
-        const addressLine1 = serialized.shift();
-        const addressLine2 = serialized.shift();
+        const name = data.shift();
+        const addressLine1 = data.shift();
+        const addressLine2 = data.shift();
         if (Boolean(name) || Boolean(addressLine1) || Boolean(addressLine2)) {
             const beneficiary = {
                 name: name?.length
@@ -120,7 +120,7 @@ export function deserialize(qr) {
                     : undefined,
                 city: addressLine2?.length
                     ? addressLine2
-                    : undefined
+                    : undefined,
             };
             cleanUndefined(beneficiary);
             output.payments[i].beneficiary = beneficiary;
@@ -145,14 +145,15 @@ function bysquareHeaderDecoder(header) {
         bysquareType,
         version,
         documentType,
-        reserved
+        reserved,
     };
 }
 export class DecodeError extends Error {
+    cause;
+    name = "DecodeError";
     constructor(cause, msg) {
         super(msg);
         this.cause = cause;
-        this.name = "DecodeError";
     }
 }
 /** @deprecated */
@@ -161,19 +162,18 @@ export const parse = decode;
  * Decoding client data from QR Code 2005 symbol
  *
  * @see 3.16.
- *
  */
 export function decode(qr) {
     try {
         var bytes = base32hex.parse(qr, {
-            loose: true
+            loose: true,
         });
     }
     catch (error) {
         throw new DecodeError(error, "Unable to decode QR string base32hex encoding");
     }
     const bysquareHeader = bytes.slice(0, 2);
-    if ((bysquareHeaderDecoder(bysquareHeader).version > 1 /* Version["1.1.0"] */)) {
+    if ((bysquareHeaderDecoder(bysquareHeader).version > Version["1.1.0"])) {
         throw new Error("Unsupported Bysquare version");
     }
     /**
@@ -195,22 +195,25 @@ export function decode(qr) {
     const header = new Uint8Array([
         ...defaultProperties,
         ...defaultDictionarySize,
-        ...uncompressedSize
+        ...uncompressedSize,
     ]);
     const payload = bytes.slice(4);
     const body = new Uint8Array([
         ...header,
-        ...payload
+        ...payload,
     ]);
     try {
-        var decompressed = new Uint8Array(decompress(body));
+        var decompressed = decompress(body);
     }
     catch (error) {
         throw new DecodeError(error, "LZMA decompression failed");
     }
+    if (typeof decompressed === "string") {
+        return deserialize(decompressed);
+    }
     const _checksum = decompressed.slice(0, 4);
     const decompressedBody = decompressed.slice(4);
-    const decoded = new TextDecoder("utf-8").decode(decompressedBody);
+    const decoded = new TextDecoder("utf-8").decode(decompressedBody.buffer);
     return deserialize(decoded);
 }
 /**
@@ -222,7 +225,7 @@ export function decode(qr) {
 export function detect(qr) {
     try {
         var parsed = base32hex.parse(qr, {
-            loose: true
+            loose: true,
         });
     }
     catch {
@@ -232,11 +235,11 @@ export function detect(qr) {
         return false;
     }
     const bysquareHeader = parsed.subarray(0, 2);
-    const { bysquareType, version, documentType, reserved } = bysquareHeaderDecoder(bysquareHeader);
+    const { bysquareType, version, documentType, reserved, } = bysquareHeaderDecoder(bysquareHeader);
     const isValid = [bysquareType, version, documentType, reserved]
         .every((nibble, index) => {
         if (index === 1) {
-            return nibble <= 1 /* Version["1.1.0"] */;
+            return nibble <= Version["1.1.0"];
         }
         return 0x00 <= nibble && nibble <= 0x0F;
     });

package/dist/encode.js

@@ -28,11 +28,11 @@ header = [
     if (!isValid) {
         throw new Error("Invalid header byte value, valid range <0,15>");
     }
-    const [bySquareType, version, documentType, reserved] = header;
+    const [bySquareType, version, documentType, reserved,] = header;
     // Combine 4-nibbles to 2-bytes
     const mergedNibbles = Uint8Array.from([
         (bySquareType << 4) | (version << 0),
-        (documentType << 4) | (reserved << 0)
+        (documentType << 4) | (reserved << 0),
     ]);
     return mergedNibbles;
 }
@@ -59,7 +59,7 @@ export function addChecksum(serialized) {
     const byteArray = new TextEncoder().encode(serialized);
     return Uint8Array.from([
         ...new Uint8Array(checksum),
-        ...Uint8Array.from(byteArray)
+        ...Uint8Array.from(byteArray),
     ]);
 }
 /**
@@ -158,9 +158,9 @@ export function encode(model, options = { deburr: true }) {
         // ...headerBysquare([0x00, Version["1.1.0"], 0x00, 0x00]),
         ...headerBysquare([0x00, 0x00, 0x00, 0x00]),
         ...headerDataLength(withChecksum.byteLength),
-        ...lzmaBody
+        ...lzmaBody,
     ]);
     return base32hex.stringify(output, {
-        pad: false
+        pad: false,
     });
 }

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { encode, generate } from "./encode.js";
 export { decode, detect, parse } from "./decode.js";
+export { encode, generate } from "./encode.js";
 export * from "./types.js";

package/dist/index.js

@@ -1,3 +1,3 @@
-export { encode, generate } from "./encode.js";
 export { decode, detect, parse } from "./decode.js";
+export { encode, generate } from "./encode.js";
 export * from "./types.js";

package/dist/types.d.ts

@@ -4,7 +4,7 @@
  * 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 {
+export declare enum Version {
     /**
      * 2013-02-22
      * Created this document from original by square specifications
@@ -149,7 +149,7 @@ export type SimplePayment = {
      *
      * Mena v ISO 4217 formáte (3 písmená). Príklad: "EUR"
      */
-    currencyCode: CurrencyCode;
+    currencyCode: string | CurrencyCode;
     /**
      * Formát YYYYMMDD
      *
@@ -210,7 +210,7 @@ export type StandingOrder = SimplePayment & {
      * medzi 1 a 31. Deň v týždni je číslo medzi 1 a 7 (1 = pondelok, 2 =utorok,
      * …, 7 = nedeľa).
      */
-    day?: Day;
+    day?: number | Day;
     /**
      * Medzerou oddelený zoznam mesiacov, v ktoré sa má platba uskutočniť.
      */

package/dist/types.js

@@ -1,3 +1,22 @@
+/**
+ * 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 var Version;
+(function (Version) {
+    /**
+     * 2013-02-22
+     * Created this document from original by square specifications
+     */
+    Version[Version["1.0.0"] = 0] = "1.0.0";
+    /**
+     * 2015-06-24
+     * Added fields for beneficiary name and address
+     */
+    Version[Version["1.1.0"] = 1] = "1.1.0";
+})(Version || (Version = {}));
 /**
  * Kalendárny mesiac.
  */

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.8.0",
+	"version": "2.8.2",
 	"license": "Apache-2.0",
 	"funding": "https://github.com/sponsors/xseman",
 	"homepage": "https://github.com/xseman/bysquare#readme",
@@ -19,12 +19,12 @@
 	"scripts": {
 		"prebuild": "tsc --build --clean",
 		"build": "tsc --build",
-		"format": "dprint fmt ./src/**/*",
+		"fmt": "dprint fmt ./src/**/*",
 		"typecheck": "tsc --noEmit",
 		"version": "git checkout develop && npm test",
 		"postversion": "echo 'Now run npm run build && npm publish'",
-		"test": "node --test --loader tsx --no-warnings src/*.test.ts",
-		"test:watch": "node --test --watch --loader tsx --no-warnings src/*.test.ts"
+		"test": "TS_NODE_TRANSPILE_ONLY=true node --test --loader=ts-node/esm --no-warnings src/*.test.ts",
+		"test:watch": "TS_NODE_TRANSPILE_ONLY=true node --test --watch --loader=ts-node/esm --no-warnings src/*.test.ts"
 	},
 	"dependencies": {
 		"crc-32": "~1.2.0",
@@ -34,10 +34,10 @@
 	},
 	"devDependencies": {
 		"@types/lodash.deburr": "~4.1.0",
-		"@types/node": ">=16.14",
-		"dprint": "~0.41.0",
-		"tsx": "~3.12.0",
-		"typescript": "~5.0.0"
+		"@types/node": ">=18.18.2",
+		"dprint": "~0.43.0",
+		"ts-node": "~10.9.0",
+		"typescript": "~5.3.0"
 	},
 	"type": "module",
 	"bin": "./dist/cli.js",
@@ -53,7 +53,7 @@
 		"!dist/*.test.*"
 	],
 	"engines": {
-		"node": ">=16",
+		"node": ">=18.18.2",
 		"npm": ">=7"
 	}
 }