bysquare 2.12.0 → 2.12.1

package/README.md

@@ -4,15 +4,17 @@
 the Slovak Banking Association in 2013. It is incorporated into a variety of
 invoices, reminders and other payment regulations.
 
-## What it is
+## Why
 
-- Simple JavaScript library to encode and decode "PAY by square" string.
-- Aim to support simpe programming interface to encode and decode data for QR.
+It's simple, I couldn't find any implementation of "PAY by square" standard for
+JavaScript, so I decided to create one and share it with the community to help
+individuals and businesses to create QR codes for their invoices.
 
-## What it is not
+## Features
 
-- Generating QR code images.
-- Parsing QR code images.
+- TypeScript support
+- Compatible with Slovak banking apps
+- Runtime-independent JavaScript implementation
 
 ## Installation
 
@@ -24,30 +26,13 @@ invoices, reminders and other payment regulations.
 [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
+### npm
 
 ```sh
-npm install bysquare
+$ npm install bysquare
 ```
 
-### CLI Node `v18+`
-
-```sh
-npm install --global bysquare
-```
-
-### deno
-
-Since `v1.28+` import from npm registry using `npm:` prefix.
-
-```ts
-import {
-	decode,
-	encode,
-} from "npm:bysquare@latest";
-```
-
-### Browser
+### browser
 
 ```html
 <script type="module">
@@ -80,6 +65,14 @@ const qrstring = simplePayment({
 
 For more complex data use `encode` and `decode` functions:
 
+> [!NOTE]
+> Encoded data are without diacritics
+>
+> The library removes all diacritics from the input data to ensure maximum
+> compatibility, as not all banks support diacritics, which may lead to errors.
+> If you need to retain diacritics, disable deburr option when encoding data -
+> `encode(model, { deburr: false })`.
+
 ```ts
 import {
 	CurrencyCode,
@@ -113,13 +106,17 @@ const model = decode(qrstring);
 
 ## CLI
 
+```sh
+$ npm install --global bysquare
+```
+
 ### Encode
 
 Encode JSON or JSONL data from files and print the corresponding QR code.
 
 ```sh
-npx bysquare --encode file1.json file2.json...
-npx bysquare --encode file.jsonl
+$ bysquare --encode file1.json file2.json...
+$ bysquare --encode file.jsonl
 ```
 
 ### Decode
@@ -128,40 +125,14 @@ 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 --decode <qrstring>
+$ bysquare --decode <qrstring>
 ```
 
 ## How it works
 
 ### Encoding sequence
 
-![logic](./docs/uml/logic.svg)
-
-## Platform support
-
-I mainly focus on LTS versions of Node.js and try to use the most idiomatic
-ECMAScript possible to avoid specific runtime coupling.
-
-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.
-
-## Troubleshooting & Recommendations
-
-### Encoded data are without diacritics
-
-The library removes all diacritics from the input data to ensure maximum compatibility, as not all banks support diacritics, which may lead to errors. If you need to retain diacritics, disable deburr option when encoding data - `encode(model, { deburr: false })`.
+<image src="./docs/logic.svg" alt="encode" width="500px">
 
 ## Related
 

package/dist/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright Filip Seman
+ * SPDX-License-Identifier: Apache-2.0
+ */
 export { decode, detect, parse } from "./decode.js";
 export { encode, generate } from "./encode.js";
 export { validateDataModel, ValidationErrorMessage } from "./validations.js";

package/dist/index.js

@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright Filip Seman
+ * SPDX-License-Identifier: Apache-2.0
+ */
 export { decode, detect, parse } from "./decode.js";
 export { encode, generate } from "./encode.js";
 export { validateDataModel, ValidationErrorMessage } from "./validations.js";

package/dist/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/base32hex.test.ts","../src/base32hex.ts","../src/cli.ts","../src/crc32.test.ts","../src/crc32.ts","../src/deburr.test.ts","../src/deburr.ts","../src/decode.test.ts","../src/decode.ts","../src/encode.test.ts","../src/encode.ts","../src/helper.test.ts","../src/helpers.ts","../src/index.ts","../src/test_assets.ts","../src/types.ts","../src/validations.test.ts","../src/validations.ts"],"version":"5.6.2"}
+{"root":["../src/base32hex.ts","../src/cli.ts","../src/crc32.ts","../src/deburr.ts","../src/decode.ts","../src/encode.ts","../src/helpers.ts","../src/index.ts","../src/test_assets.ts","../src/types.ts","../src/validations.ts"],"version":"5.6.2"}

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.12.0",
+	"version": "2.12.1",
 	"license": "Apache-2.0",
 	"funding": "https://github.com/sponsors/xseman",
 	"homepage": "https://github.com/xseman/bysquare#readme",
@@ -17,18 +17,15 @@
 		"url": "git+https://github.com/xseman/bysquare.git"
 	},
 	"scripts": {
-		"prebuild": "tsc --build --clean",
 		"build": "tsc --build",
 		"fmt": "dprint fmt",
 		"fmt:check": "dprint check",
 		"typecheck": "tsc --noEmit",
-		"version": "git checkout develop && npm test",
-		"postversion": "echo 'Now run npm run build && npm publish'",
 		"test": "TS_NODE_TRANSPILE_ONLY=true node --test --experimental-test-coverage --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": {
-		"lzma1": "0.0.3",
+		"lzma1": "0.0.5",
 		"validator": "^13.12.0"
 	},
 	"devDependencies": {
@@ -41,7 +38,6 @@
 	"type": "module",
 	"bin": "./dist/cli.js",
 	"types": "./dist/index.d.ts",
-	"module": "./dist/index.js",
 	"exports": {
 		".": {
 			"import": "./dist/index.js"
@@ -50,9 +46,5 @@
 	"files": [
 		"dist",
 		"!dist/*.test.*"
-	],
-	"engines": {
-		"node": ">=16",
-		"npm": ">=7"
-	}
+	]
 }