bysquare 2.6.0 → 2.7.0

package/README.md

@@ -1,8 +1,9 @@
 # bysquare
 
-![version][version] ![build][build]
+![version][version]
+![build][build]
 
-Simple JavaScript library to generate and parse "PAY by square" string.
+Simple JavaScript library to encode and decode "PAY by square" string.
 
 **What is `PAY by square`?**
 
@@ -18,6 +19,10 @@ transformed into images depends on how you implement it. See
 
 ## Install
 
+**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**
 
 ```sh
@@ -28,14 +33,14 @@ npm install bysquare
 
 ```html
 <script type="module">
-	import { generate, parse } from "https://esm.sh/bysquare@2.4.0/";
+	import { encode, decode } from "https://esm.sh/bysquare@2.4.0/";
 </script>
 ```
 
 **Deno** `v1.28+`, just import `npm:bysquare` `v2.1.0+`
 
 ```ts
-import { generate, parse } from "npm:bysquare@2.1.0"
+import { encode, decode } from "npm:bysquare@2.1.0";
 ```
 
 **CLI** (Node.JS `v18`+)
@@ -53,42 +58,45 @@ npm install --global bysquare
 # API
 
 ```ts
-generate(model: DataModel, options?: Options): string
-parse(qr: string): DataModel
+encode(model: DataModel, options?: Options): string
+decode(qr: string): DataModel
 detect(qr: string): Boolean
 ```
 
 # Usage
 
-## Generate
+## Encode
 
 ```ts
-import { CurrencyCode, DataModel, generate, PaymentOptions } from "bysquare"
+import { CurrencyCode, DataModel, encode, PaymentOptions } from "bysquare";
 
 // string ready to be encoded to QR
-const qrString = generate({
+const qrString = encode({
 	invoiceId: "random-id",
 	payments: [
 		{
 			type: PaymentOptions.PaymentOrder,
 			amount: 100.0,
 			bankAccounts: [
-				{ iban: "SK9611000000002918599669" }
+				{
+					iban: "SK9611000000002918599669",
+				},
 			],
 			currencyCode: CurrencyCode.EUR,
-			variableSymbol: "123"
-		}
-	]
-})
+			variableSymbol: "123",
+		},
+	],
+});
 ```
 
-## Parse
+## Decode
 
 ```ts
-import { parse } from "bysquare"
+import { decode } from "bysquare";
 
-const model =
-	parse("0405QH8090IFU27IV0J6HGGLIOTIBVHNQQJQ6LAVGNBT363HR13JC6CB54HSI0KH9FCRASHNQBSKAQD2LJ4AU400UVKDNDPFRKLOBEVVVU0QJ000")
+const model = decode(
+	"0405QH8090IFU27IV0J6HGGLIOTIBVHNQQJQ6LAVGNBT363HR13JC6CB54HSI0KH9FCRASHNQBSKAQD2LJ4AU400UVKDNDPFRKLOBEVVVU0QJ000"
+);
 
 // {
 // 	invoiceId: "random-id",
@@ -107,7 +115,9 @@ const model =
 //
 ```
 
-## CLI
+# CLI
+
+## Encode
 
 Encode JSON data from a file and print the corresponding QR code. The file
 argument should be a path to a JSON file.
@@ -116,6 +126,8 @@ argument should be a path to a JSON file.
 npx bysquare --encode <file>
 ```
 
+## Decode
+
 Decode the specified QR code string and print the corresponding JSON data. The
 qrstring argument should be a valid QR code string.
 
@@ -125,12 +137,14 @@ npx bysquare --decode <qrstring>
 
 ## 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>
+-   <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>
 
 [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

package/dist/cli.js

@@ -1,8 +1,8 @@
 #!/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";
+import { encode } from "./encode.js";
+import { decode } from "./decode.js";
 const args = parseArgs({
     allowPositionals: true,
     options: {
@@ -26,7 +26,7 @@ if (process.stdin.isTTY) {
         const file = args.values.encode;
         if (existsSync(file)) {
             const data = readFileSync(file, "utf8");
-            console.log(generate(JSON.parse(data)));
+            console.log(encode(JSON.parse(data)));
         }
         else {
             console.error(`File ${file} doesn't exists`);
@@ -36,7 +36,7 @@ if (process.stdin.isTTY) {
     /** input string */
     if (args.values.decode) {
         const qrstring = args.values.decode;
-        console.log(JSON.stringify(parse(qrstring), null, 4));
+        console.log(JSON.stringify(decode(qrstring), null, 4));
     }
     if (args.values.help || Object.keys(args.values).length === 0) {
         console.log([

package/dist/{parse.d.ts → decode.d.ts}

@@ -10,12 +10,15 @@ export declare class DecodeError extends Error {
     name: string;
     constructor(cause: Error, msg?: string);
 }
+/** @deprecated */
+export declare const parse: typeof decode;
 /**
  * Decoding client data from QR Code 2005 symbol
  *
  * @see 3.16.
+ *
  */
-export declare function parse(qr: string): DataModel;
+export declare function decode(qr: string): DataModel;
 /**
  * Detect if qr string contains bysquare header.
  *

package/dist/{parse.js → decode.js}

@@ -155,12 +155,15 @@ export class DecodeError extends Error {
         this.name = "DecodeError";
     }
 }
+/** @deprecated */
+export const parse = decode;
 /**
  * Decoding client data from QR Code 2005 symbol
  *
  * @see 3.16.
+ *
  */
-export function parse(qr) {
+export function decode(qr) {
     try {
         var bytes = base32hex.parse(qr, {
             loose: true

package/dist/{generate.d.ts → encode.d.ts}

@@ -49,8 +49,10 @@ type Options = {
      */
     deburr: boolean;
 };
+/** @deprecated */
+export declare const generate: typeof encode;
 /**
  * Generate QR string ready for encoding into text QR code
  */
-export declare function generate(model: DataModel, options?: Options): string;
+export declare function encode(model: DataModel, options?: Options): string;
 export {};

package/dist/{generate.js → encode.js}

@@ -137,10 +137,12 @@ function removeDiacritics(model) {
         }
     }
 }
+/** @deprecated */
+export const generate = encode;
 /**
  * Generate QR string ready for encoding into text QR code
  */
-export function generate(model, options = { deburr: true }) {
+export function encode(model, options = { deburr: true }) {
     if (options.deburr) {
         removeDiacritics(model);
     }

package/dist/index.d.ts

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

package/dist/index.js

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

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.6.0",
+	"version": "2.7.0",
 	"license": "Apache-2.0",
 	"funding": "https://github.com/sponsors/xseman",
 	"homepage": "https://github.com/xseman/bysquare#readme",
@@ -35,14 +35,13 @@
 	"devDependencies": {
 		"@types/lodash.deburr": "~4.1.0",
 		"@types/node": ">=16.14",
-		"dprint": "~0.36.0",
+		"dprint": "~0.41.0",
 		"tsx": "~3.12.0",
 		"typescript": "~5.0.0"
 	},
 	"type": "module",
 	"bin": "./dist/cli.js",
 	"types": "./dist/index.d.ts",
-	"main": "./dist/index.js",
 	"module": "./dist/index.js",
 	"exports": {
 		".": {
@@ -54,7 +53,7 @@
 		"!dist/*.test.*"
 	],
 	"engines": {
-		"node": ">=14.13.1 || >=16.0.0",
-		"npm": ">=7.0"
+		"node": ">=16",
+		"npm": ">=7"
 	}
 }