bysquare 2.4.0 → 2.6.0

package/README.md

@@ -14,7 +14,7 @@ reminders and other payment regulations.
 
 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](examples).
+[examples](./docs/examples/).
 
 ## Install
 
@@ -24,38 +24,33 @@ transformed into images depends on how you implement it. See
 npm install bysquare
 ```
 
-**GitHub**
+**Browser**
 
-```sh
-# same as latest released npm registry version
-npm install xseman/bysquare#master
+```html
+<script type="module">
+	import { generate, parse } from "https://esm.sh/bysquare@2.4.0/";
+</script>
+```
 
-# latest unreleased changes
-npm install xseman/bysquare#develop
+**Deno** `v1.28+`, just import `npm:bysquare` `v2.1.0+`
 
-# specific tag version, e.g. v2.1.0
-npm install xseman/bysquare#v2.1.0
+```ts
+import { generate, parse } from "npm:bysquare@2.1.0"
 ```
 
-**CLI**
+**CLI** (Node.JS `v18`+)
 
 ```sh
 npm install --global bysquare
 ```
 
-**Deno** `v1.28+`, just import `npm:bysquare` `v2.1.0+`
+# How it works
 
-```
-import { generate, parse } from "npm:bysquare@2.1.0"
-```
-
-## How it works
+## Encoding sequence
 
-### Encoding sequence
+![logic](./docs/uml/logic.svg)
 
-![logic](./doc/uml/logic.svg)
-
-## API
+# API
 
 ```ts
 generate(model: DataModel, options?: Options): string
@@ -63,14 +58,14 @@ parse(qr: string): DataModel
 detect(qr: string): Boolean
 ```
 
-## Usage
+# Usage
 
-Generate
+## Generate
 
 ```ts
-import { DataModel, generate, PaymentOptions } from "bysquare"
+import { CurrencyCode, DataModel, generate, PaymentOptions } from "bysquare"
 
-// long string ready to be encoded to QR
+// string ready to be encoded to QR
 const qrString = generate({
 	invoiceId: "random-id",
 	payments: [
@@ -80,14 +75,14 @@ const qrString = generate({
 			bankAccounts: [
 				{ iban: "SK9611000000002918599669" }
 			],
-			currencyCode: "EUR",
+			currencyCode: CurrencyCode.EUR,
 			variableSymbol: "123"
 		}
 	]
 })
 ```
 
-Parse
+## Parse
 
 ```ts
 import { parse } from "bysquare"
@@ -112,44 +107,20 @@ const model =
 //
 ```
 
-You can use json file with valid model to generate qr-string.
+## CLI
+
+Encode JSON data from a file and print the corresponding QR code. The file
+argument should be a path to a JSON file.
 
 ```sh
-# example.json
-# {
-# 	"invoiceId": "random-id",
-# 	"payments": [
-# 		{
-# 			"type": 1,
-# 			"amount": 100.0,
-# 			"bankAccounts": [{ "iban": "SK9611000000002918599669" }],
-# 			"currencyCode": "EUR",
-# 			"variableSymbol": "123"
-# 		}
-# 	]
-# }
-
-$ npx bysquare ./example.json
-$ 0405QH8090IFU27IV0J6HGGLIOTIBVHNQQJQ6LAVGNBT363HR13JC6CB54HSI0KH9FCRASHNQBSKAQD2LJ4AU400UVKDNDPFRKLOBEVVVU0QJ000
+npx bysquare --encode <file>
 ```
 
-You can also use stdin.
+Decode the specified QR code string and print the corresponding JSON data. The
+qrstring argument should be a valid QR code string.
 
 ```sh
-$ npx bysquare <<< '{
-    "invoiceId": "random-id",
-    "payments": [
-        {
-            "type": 1,
-            "amount": 100.0,
-            "bankAccounts": [{ "iban": "SK9611000000002918599669" }],
-            "currencyCode": "EUR",
-            "variableSymbol": "123"
-        }
-    ]
-}'
-
-$ 0405QH8090IFU27IV0J6HGGLIOTIBVHNQQJQ6LAVGNBT363HR13JC6CB54HSI0KH9FCRASHNQBSKAQD2LJ4AU400UVKDNDPFRKLOBEVVVU0QJ000
+npx bysquare --decode <qrstring>
 ```
 
 ## Related
@@ -161,23 +132,5 @@ $ 0405QH8090IFU27IV0J6HGGLIOTIBVHNQQJQ6LAVGNBT363HR13JC6CB54HSI0KH9FCRASHNQBSKAQ
 - <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>
 
-<!--
-Versioning
-----------
-
-https://github.com/dherges/npm-version-git-flow
-
-- Stash unfinished work
-- Run `npm test`
-- Run `npm version <patch, minor, major>`
-- Commit and push
-- Follow git-flow instructions
-- Checkout to master
-- Build artefacts
-- Push commits and tag, git push && git push --tags
-- Validate with `npm publish --dry-run`
-- Publish to npm, `npm publish`
--->
-
 [build]: https://img.shields.io/github/actions/workflow/status/xseman/bysquare/tests.yml
 [version]: https://img.shields.io/npm/v/bysquare

package/dist/cli.js

@@ -0,0 +1,81 @@
+#!/usr/bin/env node
+import { existsSync, readFileSync } from "node:fs";
+import { parseArgs } from "node:util";
+import { generate } from "./generate.js";
+import { parse } from "./parse.js";
+const args = parseArgs({
+    allowPositionals: true,
+    options: {
+        decode: {
+            type: "string",
+            short: "d"
+        },
+        encode: {
+            type: "string",
+            short: "e"
+        },
+        help: {
+            type: "boolean",
+            short: "h"
+        }
+    }
+});
+if (process.stdin.isTTY) {
+    /** json file */
+    if (args.values.encode) {
+        const file = args.values.encode;
+        if (existsSync(file)) {
+            const data = readFileSync(file, "utf8");
+            console.log(generate(JSON.parse(data)));
+        }
+        else {
+            console.error(`File ${file} doesn't exists`);
+            process.exit(1);
+        }
+    }
+    /** input string */
+    if (args.values.decode) {
+        const qrstring = args.values.decode;
+        console.log(JSON.stringify(parse(qrstring), null, 4));
+    }
+    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",
+            "",
+            "SYNOPSIS",
+            "	bysquare [OPTIONS]",
+            "",
+            "DESCRIPTION",
+            "	bysquare is a command-line tool that provides a simple Node.js library to generate ",
+            "	and parse PAY bysquare standard. It offers functionality to encode JSON data into a ",
+            "	corresponding QR code and decode a QR code string to obtain the associated JSON data.",
+            "",
+            "OPTIONS",
+            "	-d, --decode <qrstring>",
+            "		Decode the specified QR code string and print the corresponding JSON data.",
+            "		The qrstring argument should be a valid QR code string.",
+            "",
+            "	-e, --encode <file>",
+            "		Encode JSON data from a file and print the corresponding QR code.",
+            "		The file argument should be a path to a JSON file.",
+            "",
+            "	-h, --help",
+            "		Display the help message and exit.",
+            "",
+            "USAGE",
+            "	Encoding JSON data from a file",
+            "",
+            `	${process.argv[1]} --encode <file>`,
+            "	The <file> argument should be the path to the JSON file you want to encode.",
+            "	The tool will read the file, generate a QR code representing the JSON data",
+            "",
+            "	Decoding a QR code string",
+            "",
+            `	${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/{lib/mjs → dist}/generate.js

@@ -45,7 +45,7 @@ export function headerDataLength(length) {
         throw new Error("The maximum compressed data size has been reached");
     }
     const header = new ArrayBuffer(2);
-    new DataView(header).setUint16(0, length);
+    new DataView(header).setUint16(0, length, true);
     return new Uint8Array(header);
 }
 /**
@@ -80,7 +80,7 @@ export function serialize(data) {
         serialized.push(p.variableSymbol);
         serialized.push(p.constantSymbol);
         serialized.push(p.specificSymbol);
-        serialized.push(p.originatorRefInfo);
+        serialized.push(p.originatorsReferenceInformation);
         serialized.push(p.paymentNote);
         serialized.push(p.bankAccounts.length.toString());
         for (const ba of p.bankAccounts) {
@@ -103,7 +103,7 @@ export function serialize(data) {
             serialized.push(p.directDebitType?.toString());
             serialized.push(p.variableSymbol?.toString());
             serialized.push(p.specificSymbol?.toString());
-            serialized.push(p.originatorRefInfo?.toString());
+            serialized.push(p.originatorsReferenceInformation?.toString());
             serialized.push(p.mandateId?.toString());
             serialized.push(p.creditorId?.toString());
             serialized.push(p.contractId?.toString());

package/{lib/mjs → dist}/parse.js

@@ -1,7 +1,7 @@
 import { decompress } from "lzma1";
 import { base32hex } from "rfc4648";
 import { PaymentOptions } from "./index.js";
-function cleanEmptyProps(obj) {
+function cleanUndefined(obj) {
     Object.keys(obj).forEach((key) => {
         if (typeof obj[key] === "undefined") {
             delete obj[key];
@@ -50,7 +50,7 @@ export function deserialize(qr) {
             specificSymbol: specifics?.length
                 ? specifics
                 : undefined,
-            originatorRefInfo: originatorRefInfo?.length
+            originatorsReferenceInformation: originatorRefInfo?.length
                 ? originatorRefInfo
                 : undefined,
             paymentNote: paymentNote?.length
@@ -70,7 +70,7 @@ export function deserialize(qr) {
                     ? bic
                     : undefined
             };
-            cleanEmptyProps(account);
+            cleanUndefined(account);
             payment.bankAccounts.push(account);
         }
         serialized.shift(); // StandingOrderExt
@@ -103,7 +103,7 @@ export function deserialize(qr) {
             default:
                 break;
         }
-        cleanEmptyProps(payment);
+        cleanUndefined(payment);
         output.payments.push(payment);
     }
     for (let i = 0; i < paymentslen; i++) {
@@ -122,7 +122,7 @@ export function deserialize(qr) {
                     ? addressLine2
                     : undefined
             };
-            cleanEmptyProps(beneficiary);
+            cleanUndefined(beneficiary);
             output.payments[i].beneficiary = beneficiary;
         }
     }
@@ -149,11 +149,10 @@ function bysquareHeaderDecoder(header) {
     };
 }
 export class DecodeError extends Error {
-    cause;
-    name = "DecodeError";
     constructor(cause, msg) {
         super(msg);
         this.cause = cause;
+        this.name = "DecodeError";
     }
 }
 /**
@@ -188,14 +187,12 @@ export function parse(qr) {
      */
     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 uncompressedSize = new Uint8Array(8);
+    uncompressedSize.set(bytes.slice(2, 4));
     const header = new Uint8Array([
         ...defaultProperties,
         ...defaultDictionarySize,
-        ...new Uint8Array(uncompressedSize)
+        ...uncompressedSize
     ]);
     const payload = bytes.slice(4);
     const body = new Uint8Array([