bysquare 2.8.2 → 2.9.0

package/README.md

@@ -46,7 +46,10 @@ npm install --global bysquare
 Since `v1.28+` import from npm registry using `npm:` prefix.
 
 ```ts
-import { decode, encode } from "npm:bysquare@2.8.0";
+import {
+	decode,
+	encode,
+} from "npm:bysquare@2.8.0";
 ```
 
 ### Browser
@@ -68,7 +71,12 @@ import { decode, encode } from "npm:bysquare@2.8.0";
 ### Encode
 
 ```ts
-import { CurrencyCode, DataModel, encode, PaymentOptions } from "bysquare";
+import {
+	CurrencyCode,
+	DataModel,
+	encode,
+	PaymentOptions,
+} from "bysquare";
 
 // string ready to be encoded to QR
 const qrString = encode({

package/dist/cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { existsSync, readFileSync } from "node:fs";
+import { existsSync, readFileSync, } from "node:fs";
 import process from "node:process";
 import { parseArgs } from "node:util";
 import { decode } from "./decode.js";

package/dist/deburr.d.ts

@@ -0,0 +1,5 @@
+export declare function deburrLetter(key: string): string;
+/**
+ * @desc Deburrs string by converting Latin-1 Supplement and Latin Extended-A letters to basic Latin letters and removing [combining diacritical marks](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks).
+ */
+export declare function deburr(text: string): string;

package/dist/deburr.js

@@ -0,0 +1,78 @@
+/** Used to map Latin Unicode letters to basic Latin letters. */
+/** dprint-ignore */
+const deburredLettersMap = {
+    // Latin-1 Supplement block.
+    '\xc0': 'A', '\xc1': 'A', '\xc2': 'A', '\xc3': 'A', '\xc4': 'A', '\xc5': 'A',
+    '\xe0': 'a', '\xe1': 'a', '\xe2': 'a', '\xe3': 'a', '\xe4': 'a', '\xe5': 'a',
+    '\xc7': 'C', '\xe7': 'c',
+    '\xd0': 'D', '\xf0': 'd',
+    '\xc8': 'E', '\xc9': 'E', '\xca': 'E', '\xcb': 'E',
+    '\xe8': 'e', '\xe9': 'e', '\xea': 'e', '\xeb': 'e',
+    '\xcc': 'I', '\xcd': 'I', '\xce': 'I', '\xcf': 'I',
+    '\xec': 'i', '\xed': 'i', '\xee': 'i', '\xef': 'i',
+    '\xd1': 'N', '\xf1': 'n',
+    '\xd2': 'O', '\xd3': 'O', '\xd4': 'O', '\xd5': 'O', '\xd6': 'O', '\xd8': 'O',
+    '\xf2': 'o', '\xf3': 'o', '\xf4': 'o', '\xf5': 'o', '\xf6': 'o', '\xf8': 'o',
+    '\xd9': 'U', '\xda': 'U', '\xdb': 'U', '\xdc': 'U',
+    '\xf9': 'u', '\xfa': 'u', '\xfb': 'u', '\xfc': 'u',
+    '\xdd': 'Y', '\xfd': 'y', '\xff': 'y',
+    '\xc6': 'Ae', '\xe6': 'ae',
+    '\xde': 'Th', '\xfe': 'th',
+    '\xdf': 'ss',
+    // Latin Extended-A block.
+    '\u0100': 'A', '\u0102': 'A', '\u0104': 'A',
+    '\u0101': 'a', '\u0103': 'a', '\u0105': 'a',
+    '\u0106': 'C', '\u0108': 'C', '\u010a': 'C', '\u010c': 'C',
+    '\u0107': 'c', '\u0109': 'c', '\u010b': 'c', '\u010d': 'c',
+    '\u010e': 'D', '\u0110': 'D', '\u010f': 'd', '\u0111': 'd',
+    '\u0112': 'E', '\u0114': 'E', '\u0116': 'E', '\u0118': 'E', '\u011a': 'E',
+    '\u0113': 'e', '\u0115': 'e', '\u0117': 'e', '\u0119': 'e', '\u011b': 'e',
+    '\u011c': 'G', '\u011e': 'G', '\u0120': 'G', '\u0122': 'G',
+    '\u011d': 'g', '\u011f': 'g', '\u0121': 'g', '\u0123': 'g',
+    '\u0124': 'H', '\u0126': 'H', '\u0125': 'h', '\u0127': 'h',
+    '\u0128': 'I', '\u012a': 'I', '\u012c': 'I', '\u012e': 'I', '\u0130': 'I',
+    '\u0129': 'i', '\u012b': 'i', '\u012d': 'i', '\u012f': 'i', '\u0131': 'i',
+    '\u0134': 'J', '\u0135': 'j',
+    '\u0136': 'K', '\u0137': 'k', '\u0138': 'k',
+    '\u0139': 'L', '\u013b': 'L', '\u013d': 'L', '\u013f': 'L', '\u0141': 'L',
+    '\u013a': 'l', '\u013c': 'l', '\u013e': 'l', '\u0140': 'l', '\u0142': 'l',
+    '\u0143': 'N', '\u0145': 'N', '\u0147': 'N', '\u014a': 'N',
+    '\u0144': 'n', '\u0146': 'n', '\u0148': 'n', '\u014b': 'n',
+    '\u014c': 'O', '\u014e': 'O', '\u0150': 'O',
+    '\u014d': 'o', '\u014f': 'o', '\u0151': 'o',
+    '\u0154': 'R', '\u0156': 'R', '\u0158': 'R',
+    '\u0155': 'r', '\u0157': 'r', '\u0159': 'r',
+    '\u015a': 'S', '\u015c': 'S', '\u015e': 'S', '\u0160': 'S',
+    '\u015b': 's', '\u015d': 's', '\u015f': 's', '\u0161': 's',
+    '\u0162': 'T', '\u0164': 'T', '\u0166': 'T',
+    '\u0163': 't', '\u0165': 't', '\u0167': 't',
+    '\u0168': 'U', '\u016a': 'U', '\u016c': 'U', '\u016e': 'U', '\u0170': 'U', '\u0172': 'U',
+    '\u0169': 'u', '\u016b': 'u', '\u016d': 'u', '\u016f': 'u', '\u0171': 'u', '\u0173': 'u',
+    '\u0174': 'W', '\u0175': 'w',
+    '\u0176': 'Y', '\u0177': 'y', '\u0178': 'Y',
+    '\u0179': 'Z', '\u017b': 'Z', '\u017d': 'Z',
+    '\u017a': 'z', '\u017c': 'z', '\u017e': 'z',
+    '\u0132': 'IJ', '\u0133': 'ij',
+    '\u0152': 'Oe', '\u0153': 'oe',
+    '\u0149': "'n", '\u017f': 'ss'
+};
+export function deburrLetter(key) {
+    return deburredLettersMap[key];
+}
+/** Used to match Latin Unicode letters (excluding mathematical operators). */
+const reLatin = /[\xc0-\xd6\xd8-\xf6\xf8-\xff\u0100-\u017f]/g;
+/** Used to compose unicode character classes. */
+const rsComboMarksRange = "\\u0300-\\u036f\\ufe20-\\ufe23", rsComboSymbolsRange = "\\u20d0-\\u20f0";
+/** Used to compose unicode capture groups. */
+const rsCombo = "[" + rsComboMarksRange + rsComboSymbolsRange + "]";
+/**
+ * Used to match [combining diacritical marks](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks) and
+ * [combining diacritical marks for symbols](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks_for_Symbols).
+ */
+const reComboMark = RegExp(rsCombo, "g");
+/**
+ * @desc Deburrs string by converting Latin-1 Supplement and Latin Extended-A letters to basic Latin letters and removing [combining diacritical marks](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks).
+ */
+export function deburr(text) {
+    return text.replace(reLatin, deburrLetter).replace(reComboMark, "");
+}

package/dist/decode.js

@@ -138,9 +138,9 @@ export function deserialize(qr) {
 function bysquareHeaderDecoder(header) {
     const bytes = (header[0] << 8) | header[1];
     const bysquareType = bytes >> 12;
-    const version = (bytes >> 8) & 15;
-    const documentType = (bytes >> 4) & 15;
-    const reserved = bytes & 15;
+    const version = (bytes >> 8) & 0b0000_1111;
+    const documentType = (bytes >> 4) & 0b0000_1111;
+    const reserved = bytes & 0b0000_1111;
     return {
         bysquareType,
         version,
@@ -164,10 +164,9 @@ export const parse = decode;
  * @see 3.16.
  */
 export function decode(qr) {
+    let bytes;
     try {
-        var bytes = base32hex.parse(qr, {
-            loose: true,
-        });
+        bytes = base32hex.parse(qr, { loose: true });
     }
     catch (error) {
         throw new DecodeError(error, "Unable to decode QR string base32hex encoding");
@@ -202,8 +201,9 @@ export function decode(qr) {
         ...header,
         ...payload,
     ]);
+    let decompressed;
     try {
-        var decompressed = decompress(body);
+        decompressed = decompress(body);
     }
     catch (error) {
         throw new DecodeError(error, "LZMA decompression failed");
@@ -223,21 +223,24 @@ export function decode(qr) {
  * not very reliable, there is room for improvement for the future.
  */
 export function detect(qr) {
+    let parsed;
     try {
-        var parsed = base32hex.parse(qr, {
-            loose: true,
-        });
+        parsed = base32hex.parse(qr, { loose: true });
     }
     catch {
-        throw new Error("Invalid data, Unable to decode base32hex QR string");
+        return false;
     }
     if (parsed.byteLength < 2) {
         return false;
     }
     const bysquareHeader = parsed.subarray(0, 2);
-    const { bysquareType, version, documentType, reserved, } = bysquareHeaderDecoder(bysquareHeader);
-    const isValid = [bysquareType, version, documentType, reserved]
-        .every((nibble, index) => {
+    const header = bysquareHeaderDecoder(bysquareHeader);
+    const isValid = [
+        header.bysquareType,
+        header.version,
+        header.documentType,
+        header.reserved,
+    ].every((nibble, index) => {
         if (index === 1) {
             return nibble <= Version["1.1.0"];
         }

package/dist/encode.js

@@ -1,8 +1,8 @@
 import crc32 from "crc-32";
-import deburr from "lodash.deburr";
 import { compress } from "lzma1";
 import { base32hex } from "rfc4648";
-import { PaymentOptions } from "./types.js";
+import { deburr } from "./deburr.js";
+import { PaymentOptions, } from "./types.js";
 /**
  * Returns a 2 byte buffer that represents the header of the bysquare
  * specification

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.2",
+	"version": "2.9.0",
 	"license": "Apache-2.0",
 	"funding": "https://github.com/sponsors/xseman",
 	"homepage": "https://github.com/xseman/bysquare#readme",
@@ -19,7 +19,7 @@
 	"scripts": {
 		"prebuild": "tsc --build --clean",
 		"build": "tsc --build",
-		"fmt": "dprint fmt ./src/**/*",
+		"fmt": "dprint fmt",
 		"typecheck": "tsc --noEmit",
 		"version": "git checkout develop && npm test",
 		"postversion": "echo 'Now run npm run build && npm publish'",
@@ -28,16 +28,14 @@
 	},
 	"dependencies": {
 		"crc-32": "~1.2.0",
-		"lodash.deburr": "~4.1.0",
 		"lzma1": "0.0.2",
 		"rfc4648": "~1.5.0"
 	},
 	"devDependencies": {
-		"@types/lodash.deburr": "~4.1.0",
 		"@types/node": ">=18.18.2",
-		"dprint": "~0.43.0",
+		"dprint": "~0.47.0",
 		"ts-node": "~10.9.0",
-		"typescript": "~5.3.0"
+		"typescript": "~5.5.0"
 	},
 	"type": "module",
 	"bin": "./dist/cli.js",