bysquare 2.0.0 → 2.0.1

package/lib/cjs/parse.js

@@ -0,0 +1,183 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detect = exports.parse = exports.buildModel = void 0;
+const lzma_native_1 = __importDefault(require("lzma-native"));
+const rfc4648_1 = require("rfc4648");
+const index_js_1 = require("./index.js");
+function cleanEmptyProps(obj) {
+    Object.keys(obj).forEach((key) => {
+        if (typeof obj[key] === 'undefined') {
+            delete obj[key];
+        }
+    });
+}
+/**
+ * @see 3.14. Generating by square Code
+ */
+function buildModel(qr) {
+    const intermediate = qr
+        .split("\t")
+        /** The end of the qr-string might contain a NULL-terminated string */
+        .map((entry) => entry.replace("\x00", ""));
+    const invoiceId = intermediate.shift();
+    const output = {
+        invoiceId: invoiceId?.length ? invoiceId : undefined,
+        payments: []
+    };
+    const paymentslen = Number(intermediate.shift());
+    for (let i = 0; i < paymentslen; i++) {
+        const paymentOptions = intermediate.shift();
+        const ammount = intermediate.shift();
+        const currency = intermediate.shift();
+        const dueDate = intermediate.shift();
+        const variables = intermediate.shift();
+        const constants = intermediate.shift();
+        const specifics = intermediate.shift();
+        const originatorRefInfo = intermediate.shift();
+        const paymentNote = intermediate.shift();
+        let payment = {
+            type: Number(paymentOptions),
+            bankAccounts: [],
+            amount: ammount?.length ? Number(ammount) : undefined,
+            currencyCode: currency,
+            paymentDueDate: dueDate?.length ? dueDate : undefined,
+            variableSymbol: variables?.length ? variables : undefined,
+            constantSymbol: constants?.length ? constants : undefined,
+            specificSymbol: specifics?.length ? specifics : undefined,
+            originatorRefInfo: originatorRefInfo?.length ? originatorRefInfo : undefined,
+            paymentNote: paymentNote?.length ? paymentNote : undefined,
+        };
+        const accountslen = Number(intermediate.shift());
+        for (let j = 0; j < accountslen; j++) {
+            const iban = intermediate.shift();
+            if (iban === undefined || iban.length === 0) {
+                throw new Error("Missing IBAN");
+            }
+            const bic = intermediate.shift();
+            const account = {
+                iban: iban,
+                bic: bic?.length ? bic : undefined,
+            };
+            cleanEmptyProps(account);
+            payment.bankAccounts.push(account);
+        }
+        intermediate.shift(); // StandingOrderExt
+        intermediate.shift(); // DirectDebitExt
+        // narrowing payment type
+        switch (payment.type) {
+            case index_js_1.PaymentOptions.PaymentOrder:
+                break;
+            case index_js_1.PaymentOptions.StandingOrder:
+                payment = {
+                    ...payment,
+                    day: Number(intermediate.shift()),
+                    month: Number(intermediate.shift()),
+                    periodicity: intermediate.shift(),
+                    lastDate: intermediate.shift()
+                };
+                break;
+            case index_js_1.PaymentOptions.DirectDebit:
+                payment = {
+                    ...payment,
+                    directDebitScheme: Number(intermediate.shift()),
+                    directDebitType: Number(intermediate.shift()),
+                    mandateId: intermediate.shift(),
+                    creditorId: intermediate.shift(),
+                    contractId: intermediate.shift(),
+                    maxAmount: Number(intermediate.shift()),
+                    validTillDate: intermediate.shift()
+                };
+                break;
+            default:
+                break;
+        }
+        cleanEmptyProps(payment);
+        output.payments.push(payment);
+    }
+    for (let i = 0; i < paymentslen; i++) {
+        const name = intermediate.shift();
+        const addressLine1 = intermediate.shift();
+        const addressLine2 = intermediate.shift();
+        if (Boolean(name) || Boolean(addressLine1) || Boolean(addressLine2)) {
+            const beneficiary = {
+                name: name?.length ? name : undefined,
+                street: addressLine1?.length ? addressLine1 : undefined,
+                city: addressLine2?.length ? addressLine2 : undefined,
+            };
+            cleanEmptyProps(beneficiary);
+            output.payments[i].beneficiary = beneficiary;
+        }
+    }
+    return output;
+}
+exports.buildModel = buildModel;
+/**
+ * @see 3.16. Decoding client data from QR Code 2005 symbol
+ */
+function parse(qr) {
+    try {
+        var decoded = rfc4648_1.base32hex.parse(qr, {
+            out: Buffer,
+            loose: true
+        });
+    }
+    catch {
+        throw new Error("Unable to parse QR");
+    }
+    // const bysquareHeader = decoded.subarray(0, 2)
+    // const compressionHeader = decoded.subarray(2, 4)
+    const compressedData = decoded.subarray(4);
+    // @ts-ignore: Missing decored types
+    const decoder = lzma_native_1.default.createStream("rawDecoder", {
+        synchronous: true,
+        // @ts-ignore: Missing filter types
+        filters: [{ id: lzma_native_1.default.FILTER_LZMA1 }]
+    });
+    return new Promise((resolve, reject) => {
+        decoder
+            .on("data", (decompress) => {
+            // const crc32: Buffer = decompress.subarray(0, 4)
+            const tabbed = decompress.subarray(4).toString();
+            resolve(buildModel(tabbed));
+        })
+            .on("error", reject)
+            .write(compressedData, (error) => {
+            error && reject(error);
+            decoder.end();
+        });
+    });
+}
+exports.parse = parse;
+/**
+ * Detect if qr string contains bysquare header.
+ *
+ * Bysquare header does not have too much information, therefore it is
+ * not very reliable, there is room for improvement for the future.
+ */
+function detect(qr) {
+    try {
+        var parsed = rfc4648_1.base32hex.parse(qr, {
+            out: Buffer,
+            loose: true
+        });
+    }
+    catch {
+        throw new Error("Unable to parse QR string, invalid data");
+    }
+    if (parsed.byteLength < 2) {
+        return false;
+    }
+    const headerBysquare = parsed.subarray(0, 2);
+    return [...headerBysquare.toString("hex")]
+        .map((nibble) => parseInt(nibble, 16))
+        .every((nibble, index) => {
+        if ( /** version */index === 1) {
+            return 0 >= nibble && nibble <= 1;
+        }
+        return 0 <= nibble && nibble <= 15;
+    });
+}
+exports.detect = detect;

package/lib/cjs/types.js

@@ -0,0 +1,246 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CurrencyCodeEnum = exports.DirectDebitType = exports.DirectDebitScheme = exports.PaymentOptions = exports.Periodicity = exports.MonthClassifier = void 0;
+/**
+ * Selection of one or more months on which payment occurs. This is enabled
+ * only if periodicity is set to one of the following value: “Weekly,
+ * Biweekly, Monthly, Bimonthly”. Otherwise it must not be specified.
+ */
+var MonthClassifier;
+(function (MonthClassifier) {
+    MonthClassifier[MonthClassifier["January"] = 1] = "January";
+    MonthClassifier[MonthClassifier["February"] = 2] = "February";
+    MonthClassifier[MonthClassifier["March"] = 4] = "March";
+    MonthClassifier[MonthClassifier["April"] = 8] = "April";
+    MonthClassifier[MonthClassifier["May"] = 16] = "May";
+    MonthClassifier[MonthClassifier["June"] = 32] = "June";
+    MonthClassifier[MonthClassifier["July"] = 64] = "July";
+    MonthClassifier[MonthClassifier["August"] = 128] = "August";
+    MonthClassifier[MonthClassifier["September"] = 256] = "September";
+    MonthClassifier[MonthClassifier["October"] = 512] = "October";
+    MonthClassifier[MonthClassifier["November"] = 1024] = "November";
+    MonthClassifier[MonthClassifier["December"] = 2048] = "December";
+})(MonthClassifier = exports.MonthClassifier || (exports.MonthClassifier = {}));
+/**
+ * Periodicity of the payment. All valid options are „Daily“, „Weekly“,
+ * „Biweekly“, „Monthly“, „Bimonthly“, „Quarterly“, „Annually“,
+ * „Semiannually“. To find out which periodicity types are supported by the
+ * banks see the following web site: http://www.sbaonline.sk/sk/
+ */
+var Periodicity;
+(function (Periodicity) {
+    Periodicity["Daily"] = "d";
+    Periodicity["Weekly"] = "w";
+    Periodicity["Biweekly"] = "b";
+    Periodicity["Monthly"] = "m";
+    Periodicity["Bimonthly"] = "B";
+    Periodicity["Quarterly"] = "q";
+    Periodicity["Semiannually"] = "s";
+    Periodicity["Annually"] = "a";
+})(Periodicity = exports.Periodicity || (exports.Periodicity = {}));
+var PaymentOptions;
+(function (PaymentOptions) {
+    PaymentOptions[PaymentOptions["PaymentOrder"] = 1] = "PaymentOrder";
+    PaymentOptions[PaymentOptions["StandingOrder"] = 2] = "StandingOrder";
+    PaymentOptions[PaymentOptions["DirectDebit"] = 4] = "DirectDebit";
+})(PaymentOptions = exports.PaymentOptions || (exports.PaymentOptions = {}));
+/**
+ * If DirectDebitScheme value is 1, which is „SEPA“ than encoded direct
+ * debit follows SEPA direct debit scheme which means that fields MandateID,
+ * CreditorID and optional ContractID are used. If direct debit scheme is 0,
+ * which is „OTHER“ this means no specific direct debit scheme and following
+ * rules do apply:
+ *
+ * a. Creditor is identified via bank accounts
+ *
+ * b. Contract between debtor and creditor is identified using one of the
+ *    following two ways: 1. by two optional fields SpecificSymbol and
+ *    VariableSymbol. 2. by one optional field OriginatorsReferenceInformation.
+ *    If SpecificSymbol and VariableSymbol fields or
+ *    OriginatorsReferenceInformation field is filled in DirectDebitExt then
+ *    these fields do apply for the direct debit.
+ */
+var DirectDebitScheme;
+(function (DirectDebitScheme) {
+    DirectDebitScheme[DirectDebitScheme["Other"] = 0] = "Other";
+    DirectDebitScheme[DirectDebitScheme["Sepa"] = 1] = "Sepa";
+})(DirectDebitScheme = exports.DirectDebitScheme || (exports.DirectDebitScheme = {}));
+/**
+ * Can be „one­off“ for one time debit or „recurrent“ for repeated debit
+ * until cancelled.
+ *
+ * Max length 1
+ */
+var DirectDebitType;
+(function (DirectDebitType) {
+    DirectDebitType[DirectDebitType["OneOff"] = 0] = "OneOff";
+    DirectDebitType[DirectDebitType["Recurrent"] = 1] = "Recurrent";
+})(DirectDebitType = exports.DirectDebitType || (exports.DirectDebitType = {}));
+/**
+ * Currency codes based on ISO-4217
+ */
+var CurrencyCodeEnum;
+(function (CurrencyCodeEnum) {
+    CurrencyCodeEnum["AED"] = "United Arab Emirates Dirham";
+    CurrencyCodeEnum["AFN"] = "Afghanistan Afghani";
+    CurrencyCodeEnum["ALL"] = "Albania Lek";
+    CurrencyCodeEnum["AMD"] = "Armenia Dram";
+    CurrencyCodeEnum["ANG"] = "Netherlands Antilles Guilder";
+    CurrencyCodeEnum["AOA"] = "Angola Kwanza";
+    CurrencyCodeEnum["ARS"] = "Argentina Peso";
+    CurrencyCodeEnum["AUD"] = "Australia Dollar";
+    CurrencyCodeEnum["AWG"] = "Aruba Guilder";
+    CurrencyCodeEnum["AZN"] = "Azerbaijan New Manat";
+    CurrencyCodeEnum["BAM"] = "Bosnia and Herzegovina Convertible Marka";
+    CurrencyCodeEnum["BBD"] = "Barbados Dollar";
+    CurrencyCodeEnum["BDT"] = "Bangladesh Taka";
+    CurrencyCodeEnum["BGN"] = "Bulgaria Lev";
+    CurrencyCodeEnum["BHD"] = "Bahrain Dinar";
+    CurrencyCodeEnum["BIF"] = "Burundi Franc";
+    CurrencyCodeEnum["BMD"] = "Bermuda Dollar";
+    CurrencyCodeEnum["BND"] = "Brunei Darussalam Dollar";
+    CurrencyCodeEnum["BOB"] = "Bolivia Bol\u00EDviano";
+    CurrencyCodeEnum["BRL"] = "Brazil Real";
+    CurrencyCodeEnum["BSD"] = "Bahamas Dollar";
+    CurrencyCodeEnum["BTN"] = "Bhutan Ngultrum";
+    CurrencyCodeEnum["BWP"] = "Botswana Pula";
+    CurrencyCodeEnum["BYR"] = "Belarus Ruble";
+    CurrencyCodeEnum["BZD"] = "Belize Dollar";
+    CurrencyCodeEnum["CAD"] = "Canada Dollar";
+    CurrencyCodeEnum["CDF"] = "Congo/Kinshasa Franc";
+    CurrencyCodeEnum["CHF"] = "Switzerland Franc";
+    CurrencyCodeEnum["CLP"] = "Chile Peso";
+    CurrencyCodeEnum["CNY"] = "China Yuan Renminbi";
+    CurrencyCodeEnum["COP"] = "Colombia Peso";
+    CurrencyCodeEnum["CRC"] = "Costa Rica Colon";
+    CurrencyCodeEnum["CUC"] = "Cuba Convertible Peso";
+    CurrencyCodeEnum["CUP"] = "Cuba Peso";
+    CurrencyCodeEnum["CVE"] = "Cape Verde Escudo";
+    CurrencyCodeEnum["CZK"] = "Czech Republic Koruna";
+    CurrencyCodeEnum["DJF"] = "Djibouti Franc";
+    CurrencyCodeEnum["DKK"] = "Denmark Krone";
+    CurrencyCodeEnum["DOP"] = "Dominican Republic Peso";
+    CurrencyCodeEnum["DZD"] = "Algeria Dinar";
+    CurrencyCodeEnum["EGP"] = "Egypt Pound";
+    CurrencyCodeEnum["ERN"] = "Eritrea Nakfa";
+    CurrencyCodeEnum["ETB"] = "Ethiopia Birr";
+    CurrencyCodeEnum["EUR"] = "Euro Member Countries";
+    CurrencyCodeEnum["FJD"] = "Fiji Dollar";
+    CurrencyCodeEnum["FKP"] = "Falkland Islands  = Malvinas Pound";
+    CurrencyCodeEnum["GBP"] = "United Kingdom Pound";
+    CurrencyCodeEnum["GEL"] = "Georgia Lari";
+    CurrencyCodeEnum["GGP"] = "Guernsey Pound";
+    CurrencyCodeEnum["GHS"] = "Ghana Cedi";
+    CurrencyCodeEnum["GIP"] = "Gibraltar Pound";
+    CurrencyCodeEnum["GMD"] = "Gambia Dalasi";
+    CurrencyCodeEnum["GNF"] = "Guinea Franc";
+    CurrencyCodeEnum["GTQ"] = "Guatemala Quetzal";
+    CurrencyCodeEnum["GYD"] = "Guyana Dollar";
+    CurrencyCodeEnum["HKD"] = "Hong Kong Dollar";
+    CurrencyCodeEnum["HNL"] = "Honduras Lempira";
+    CurrencyCodeEnum["HRK"] = "Croatia Kuna";
+    CurrencyCodeEnum["HTG"] = "Haiti Gourde";
+    CurrencyCodeEnum["HUF"] = "Hungary Forint";
+    CurrencyCodeEnum["IDR"] = "Indonesia Rupiah";
+    CurrencyCodeEnum["ILS"] = "Israel Shekel";
+    CurrencyCodeEnum["IMP"] = "Isle of Man Pound";
+    CurrencyCodeEnum["INR"] = "India Rupee";
+    CurrencyCodeEnum["IQD"] = "Iraq Dinar";
+    CurrencyCodeEnum["IRR"] = "Iran Rial";
+    CurrencyCodeEnum["ISK"] = "Iceland Krona";
+    CurrencyCodeEnum["JEP"] = "Jersey Pound";
+    CurrencyCodeEnum["JMD"] = "Jamaica Dollar";
+    CurrencyCodeEnum["JOD"] = "Jordan Dinar";
+    CurrencyCodeEnum["JPY"] = "Japan Yen";
+    CurrencyCodeEnum["KES"] = "Kenya Shilling";
+    CurrencyCodeEnum["KGS"] = "Kyrgyzstan Som";
+    CurrencyCodeEnum["KHR"] = "Cambodia Riel";
+    CurrencyCodeEnum["KMF"] = "Comoros Franc";
+    CurrencyCodeEnum["KPW"] = "Korea  = North Won";
+    CurrencyCodeEnum["KRW"] = "Korea  = South Won";
+    CurrencyCodeEnum["KWD"] = "Kuwait Dinar";
+    CurrencyCodeEnum["KYD"] = "Cayman Islands Dollar";
+    CurrencyCodeEnum["KZT"] = "Kazakhstan Tenge";
+    CurrencyCodeEnum["LAK"] = "Laos Kip";
+    CurrencyCodeEnum["LBP"] = "Lebanon Pound";
+    CurrencyCodeEnum["LKR"] = "Sri Lanka Rupee";
+    CurrencyCodeEnum["LRD"] = "Liberia Dollar";
+    CurrencyCodeEnum["LSL"] = "Lesotho Loti";
+    CurrencyCodeEnum["LYD"] = "Libya Dinar";
+    CurrencyCodeEnum["MAD"] = "Morocco Dirham";
+    CurrencyCodeEnum["MDL"] = "Moldova Leu";
+    CurrencyCodeEnum["MGA"] = "Madagascar Ariary";
+    CurrencyCodeEnum["MKD"] = "Macedonia Denar";
+    CurrencyCodeEnum["MMK"] = "Myanmar  = Burma Kyat";
+    CurrencyCodeEnum["MNT"] = "Mongolia Tughrik";
+    CurrencyCodeEnum["MOP"] = "Macau Pataca";
+    CurrencyCodeEnum["MRO"] = "Mauritania Ouguiya";
+    CurrencyCodeEnum["MUR"] = "Mauritius Rupee";
+    CurrencyCodeEnum["MVR"] = "Maldives  = Maldive Islands Rufiyaa";
+    CurrencyCodeEnum["MWK"] = "Malawi Kwacha";
+    CurrencyCodeEnum["MXN"] = "Mexico Peso";
+    CurrencyCodeEnum["MYR"] = "Malaysia Ringgit";
+    CurrencyCodeEnum["MZN"] = "Mozambique Metical";
+    CurrencyCodeEnum["NAD"] = "Namibia Dollar";
+    CurrencyCodeEnum["NGN"] = "Nigeria Naira";
+    CurrencyCodeEnum["NIO"] = "Nicaragua Cordoba";
+    CurrencyCodeEnum["NOK"] = "Norway Krone";
+    CurrencyCodeEnum["NPR"] = "Nepal Rupee";
+    CurrencyCodeEnum["NZD"] = "New Zealand Dollar";
+    CurrencyCodeEnum["OMR"] = "Oman Rial";
+    CurrencyCodeEnum["PAB"] = "Panama Balboa";
+    CurrencyCodeEnum["PEN"] = "Peru Sol";
+    CurrencyCodeEnum["PGK"] = "Papua New Guinea Kina";
+    CurrencyCodeEnum["PHP"] = "Philippines Peso";
+    CurrencyCodeEnum["PKR"] = "Pakistan Rupee";
+    CurrencyCodeEnum["PLN"] = "Poland Zloty";
+    CurrencyCodeEnum["PYG"] = "Paraguay Guarani";
+    CurrencyCodeEnum["QAR"] = "Qatar Riyal";
+    CurrencyCodeEnum["RON"] = "Romania New Leu";
+    CurrencyCodeEnum["RSD"] = "Serbia Dinar";
+    CurrencyCodeEnum["RUB"] = "Russia Ruble";
+    CurrencyCodeEnum["RWF"] = "Rwanda Franc";
+    CurrencyCodeEnum["SAR"] = "Saudi Arabia Riyal";
+    CurrencyCodeEnum["SBD"] = "Solomon Islands Dollar";
+    CurrencyCodeEnum["SCR"] = "Seychelles Rupee";
+    CurrencyCodeEnum["SDG"] = "Sudan Pound";
+    CurrencyCodeEnum["SEK"] = "Sweden Krona";
+    CurrencyCodeEnum["SGD"] = "Singapore Dollar";
+    CurrencyCodeEnum["SHP"] = "Saint Helena Pound";
+    CurrencyCodeEnum["SLL"] = "Sierra Leone Leone";
+    CurrencyCodeEnum["SOS"] = "Somalia Shilling";
+    CurrencyCodeEnum["SPL"] = "Seborga Luigino";
+    CurrencyCodeEnum["SRD"] = "Suriname Dollar";
+    CurrencyCodeEnum["STD"] = "S\u00E3o Tom\u00E9 and Pr\u00EDncipe Dobra";
+    CurrencyCodeEnum["SVC"] = "El Salvador Colon";
+    CurrencyCodeEnum["SYP"] = "Syria Pound";
+    CurrencyCodeEnum["SZL"] = "Swaziland Lilangeni";
+    CurrencyCodeEnum["THB"] = "Thailand Baht";
+    CurrencyCodeEnum["TJS"] = "Tajikistan Somoni";
+    CurrencyCodeEnum["TMT"] = "Turkmenistan Manat";
+    CurrencyCodeEnum["TND"] = "Tunisia Dinar";
+    CurrencyCodeEnum["TOP"] = "Tonga Pa'anga";
+    CurrencyCodeEnum["TRY"] = "Turkey Lira";
+    CurrencyCodeEnum["TTD"] = "Trinidad and Tobago Dollar";
+    CurrencyCodeEnum["TVD"] = "Tuvalu Dollar";
+    CurrencyCodeEnum["TWD"] = "Taiwan New Dollar";
+    CurrencyCodeEnum["TZS"] = "Tanzania Shilling";
+    CurrencyCodeEnum["UAH"] = "Ukraine Hryvnia";
+    CurrencyCodeEnum["UGX"] = "Uganda Shilling";
+    CurrencyCodeEnum["USD"] = "United States Dollar";
+    CurrencyCodeEnum["UYU"] = "Uruguay Peso";
+    CurrencyCodeEnum["UZS"] = "Uzbekistan Som";
+    CurrencyCodeEnum["VEF"] = "Venezuela Bolivar";
+    CurrencyCodeEnum["VND"] = "Viet Nam Dong";
+    CurrencyCodeEnum["VUV"] = "Vanuatu Vatu";
+    CurrencyCodeEnum["WST"] = "Samoa Tala";
+    CurrencyCodeEnum["XAF"] = "Communaut\u00E9 Financi\u00E8re Africaine  = BEAC CFA Franc BEAC";
+    CurrencyCodeEnum["XCD"] = "East Caribbean Dollar";
+    CurrencyCodeEnum["XDR"] = "International Monetary Fund  = IMF Special Drawing Rights";
+    CurrencyCodeEnum["XOF"] = "Communaut\u00E9 Financi\u00E8re Africaine  = BCEAO Franc";
+    CurrencyCodeEnum["XPF"] = "Comptoirs Fran\u00E7ais du Pacifique  = CFP Franc";
+    CurrencyCodeEnum["YER"] = "Yemen Rial";
+    CurrencyCodeEnum["ZAR"] = "South Africa Rand";
+    CurrencyCodeEnum["ZMW"] = "Zambia Kwacha";
+    CurrencyCodeEnum["ZWD"] = "Zimbabwe Dollar";
+})(CurrencyCodeEnum = exports.CurrencyCodeEnum || (exports.CurrencyCodeEnum = {}));

package/lib/mjs/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/lib/mjs/index.js

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

package/lib/mjs/package.json

@@ -0,0 +1,69 @@
+{
+	"name": "bysquare",
+	"description": "It's a national standard for payment QR codes adopted by Slovak Banking Association (SBA)",
+	"version": "2.0.1",
+	"license": "Apache-2.0",
+	"type": "module",
+	"funding": "https://github.com/sponsors/xseman",
+	"homepage": "https://github.com/xseman/bysquare#readme",
+	"author": {
+		"name": "Filip Seman",
+		"email": "filip.seman@protonmail.com"
+	},
+	"scripts": {
+		"prebuild": "rm -rf ./lib || :",
+		"build": "tsc --project ./tsconfig.json && tsc --project ./tsconfig.cjs.json",
+		"postbuild": "bash -c 'chmod +x ./lib/{cjs,mjs}/cli.js' && cp package.json ./lib/mjs/ && jq '.type=\"commonjs\"' package.json > lib/cjs/package.json",
+		"test": "xv --loader=tsx ./src",
+		"test:watch": "find ./src/*.ts | entr xv --loader=tsx ./src",
+		"cli:local": "npm run build && npm link bysquare",
+		"version": "git flow release start v$npm_package_version",
+		"prepare": "",
+		"prepublishOnly": "npm run build",
+		"preversion": "git checkout develop",
+		"postversion": ""
+	},
+	"dependencies": {
+		"lodash.deburr": "~4.1.0",
+		"lzma-native": "7.0.1",
+		"rfc4648": "1.5.2"
+	},
+	"devDependencies": {
+		"@types/lodash.deburr": "~4.1.0",
+		"@types/lzma-native": "^4.0.1",
+		"@types/node": "~18.11.0",
+		"tsx": "~3.12.0",
+		"typescript": "~4.9.0",
+		"xv": "~2.1.0"
+	},
+	"bin": "lib/mjs/cli.js",
+	"types": "lib/mjs/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./lib/cjs/index.js",
+			"import": "./lib/mjs/index.js"
+		}
+	},
+	"files": [
+		"lib",
+		"!lib/*.test.*"
+	],
+	"engines": {
+		"node": ">=16.0",
+		"npm": ">=7.0"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/xseman/bysquare.git"
+	},
+	"keywords": [
+		"pay by square",
+		"by square",
+		"paybysquare",
+		"bysquare",
+		"payments",
+		"qr-string",
+		"qr",
+		"cli"
+	]
+}

package/lib/mjs/parse.d.ts

@@ -0,0 +1,16 @@
+import { DataModel } from "./index.js";
+/**
+ * @see 3.14. Generating by square Code
+ */
+export declare function buildModel(qr: string): DataModel;
+/**
+ * @see 3.16. Decoding client data from QR Code 2005 symbol
+ */
+export declare function parse(qr: string): Promise<DataModel>;
+/**
+ * Detect if qr string contains bysquare header.
+ *
+ * Bysquare header does not have too much information, therefore it is
+ * not very reliable, there is room for improvement for the future.
+ */
+export declare function detect(qr: string): boolean;