bysquare 1.2.2 → 1.3.0

package/README.md

@@ -21,6 +21,10 @@ your implementation. See [examples](examples).
 
 ![diagram](./docs/uml/logic.svg)
 
+[build]: https://img.shields.io/github/workflow/status/xseman/bysquare/tests
+[version]: https://img.shields.io/npm/v/bysquare
+[license]: https://img.shields.io/github/license/xseman/bysquare
+
 ## Install
 
 Node.js
@@ -37,10 +41,16 @@ npm install --global bysquare
 
 ## API
 
-### **generate(model: Model): Promise\<string>**
+```ts
+generate(model: Model): Promise<string>
+parse(qr: string): Promise<ParsedModel>
+detect(qr: string): Boolean
+```
+
+**generate(model: Model): Promise\<string>**
 
 ```ts
-import { generate, Model, parse } from "bysquare"
+import { generate, Model, parse, PaymentOptions } from "bysquare"
 
 const model: Model = {
 	IBAN: "SK9611000000002918599669",
@@ -48,35 +58,33 @@ const model: Model = {
 	CurrencyCode: "EUR",
 	VariableSymbol: "123",
 	Payments: 1,
-	PaymentOptions: 1,
+	PaymentOptions: PaymentOptions.PaymentOrder,
 	BankAccounts: 1
 }
 
-generate(model).then((qrString: string) => {
-	// "0004G0005ES17OQ09C98Q7ME34TCR3V71LVKD2AE6EGHKR82DKS5NBJ3331VUFQIV0JGMR743UJCKSAKEM9QGVVVOIVH000"
+generate(model).then((qr: string) => {
 	// your logic...
 })
 ```
 
-### **parse(qr: string): Promise\<Model>**
+**parse(qr: string): Promise\<ParsedModel>**
 
 ```ts
-import { Model, parse } from "bysquare"
+import { ParsedModel, parse } from "bysquare"
 
-const qrString = "0004G0005ES17OQ09C98Q7ME34TCR3V71LVKD2AE6EGHKR82DKS5NBJ3331VUFQIV0JGMR743UJCKSAKEM9QGVVVOIVH000"
-
-parse(qrString).then((model: Model) => {
+const qr = "0004A00090IFU27IV0J6HGGLIOTIBVHNQQJQ6LAVGNBT363HR13JC6C75G19O246KTT5G8LTLM67HOIATP4OOG8F8FDLJ6T26KFCB1690NEVPQVSG0"
+parse(qr).then((model: ParsedModel) => {
 	// your logic...
 })
 ```
 
-### **detect(qr: string): Boolean**
+**detect(qr: string): Boolean**
 
 ```ts
 import { detect } from "bysquare"
 
-const qrString = "0004G0005ES17OQ09C98Q7ME34TCR3V71LVKD2AE6EGHKR82DKS5NBJ3331VUFQIV0JGMR743UJCKSAKEM9QGVVVOIVH000"
-const isBysquare = detect(qrString)
+const qr = "0004A00090IFU27IV0J6HGGLIOTIBVHNQQJQ6LAVGNBT363HR13JC6C75G19O246KTT5G8LTLM67HOIATP4OOG8F8FDLJ6T26KFCB1690NEVPQVSG0"
+const isBysquare = detect(qr)
 
 // your logic...
 ```
@@ -88,6 +96,7 @@ You can use json file with valid model to generate qr-string.
 ```sh
 # example.json
 # {
+#     "InvoiceID: "random-id",
 #     "IBAN": "SK9611000000002918599669",
 #     "Amount": 100.0,
 #     "CurrencyCode": "EUR",
@@ -98,13 +107,14 @@ You can use json file with valid model to generate qr-string.
 # }
 
 $ npx bysquare ./example.json
-$ 0004G0005ES17OQ09C98Q7ME34TCR3V71LVKD2AE6EGHKR82DKS5NBJ3331VUFQIV0JGMR743UJCKSAKEM9QGVVVOIVH000
+$ 0004A00090IFU27IV0J6HGGLIOTIBVHNQQJQ6LAVGNBT363HR13JC6C75G19O246KTT5G8LTLM67HOIATP4OOG8F8FDLJ6T26KFCB1690NEVPQVSG0
 ```
 
 You can also use stdin.
 
 ```sh
 $ bysquare <<< '{
+	"InvoiceID": "random-id",
 	"IBAN": "SK9611000000002918599669",
 	"Amount": 100.0,
 	"CurrencyCode": "EUR",
@@ -113,49 +123,10 @@ $ bysquare <<< '{
 	"PaymentOptions": 1,
 	"BankAccounts": 1
 }'
-$ 0004G0005ES17OQ09C98Q7ME34TCR3V71LVKD2AE6EGHKR82DKS5NBJ3331VUFQIV0JGMR743UJCKSAKEM9QGVVVOIVH000
+$ 0004A00090IFU27IV0J6HGGLIOTIBVHNQQJQ6LAVGNBT363HR13JC6C75G19O246KTT5G8LTLM67HOIATP4OOG8F8FDLJ6T26KFCB1690NEVPQVSG0
 ```
 
-## Model
-
-| Option                            | Type     | Required |
-| --------------------------------- | -------- | -------- |
-| InvoiceID                         | `string` | no       |
-| Payments                          | `number` | yes      |
-| PaymentOptions                    | `number` | yes      |
-| Amount                            | `number` | no       |
-| CurrencyCode                      | `string` | yes      |
-| PaymentDueDate                    | `string` | no       |
-| VariableSymbol                    | `string` | no       |
-| ConstantSymbol                    | `string` | no       |
-| SpecificSymbol                    | `string` | no       |
-| OriginatorsReferenceInformation   | `string` | no       |
-| PaymentNote                       | `string` | no       |
-| BankAccounts                      | `number` | yes      |
-| IBAN                              | `string` | yes      |
-| BIC                               | `string` | no       |
-| StandingOrderExt                  | `number` | no       |
-| Day                               | `number` | no       |
-| Month                             | `number` | no       |
-| Periodicity                       | `string` | no       |
-| LastDate                          | `string` | no       |
-| LastDate                          | `string` | no       |
-| DirectDebitExt                    | `number` | no       |
-| DirectDebitScheme                 | `number` | no       |
-| DirectDebitType                   | `number` | no       |
-| VariableSymbol\_                  | `string` | no       |
-| SpecificSymbol\_                  | `string` | no       |
-| OriginatorsReferenceInformation\_ | `string` | no       |
-| MandateID                         | `string` | no       |
-| CreditorID                        | `string` | no       |
-| ContractID                        | `string` | no       |
-| MaxAmount                         | `number` | no       |
-| ValidTillDate                     | `string` | no       |
-| BeneficiaryName                   | `string` | no       |
-| BeneficiaryAddressLine1           | `string` | no       |
-| BeneficiaryAddressLine2           | `string` | no       |
-
-## Resources
+## Related
 
 - <https://bysquare.com/>
 - <https://devel.cz/otazka/qr-kod-pay-by-square>
@@ -164,16 +135,12 @@ $ 0004G0005ES17OQ09C98Q7ME34TCR3V71LVKD2AE6EGHKR82DKS5NBJ3331VUFQIV0JGMR743UJCKS
 - <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>
 
-<!-- Links -->
-
-[build]: https://img.shields.io/github/workflow/status/xseman/bysquare/tests
-[version]: https://img.shields.io/npm/v/bysquare
-[license]: https://img.shields.io/github/license/xseman/bysquare
-
 <!--
 Versioning
 ----------
 
+https://github.com/dherges/npm-version-git-flow
+
 - Stash unfinished work
 - Run tests and build app
 - Run the `preversion` script

package/lib/generate.d.ts

@@ -1,6 +1,9 @@
 /// <reference types="node" />
 import { Model } from "./index";
 /**
+ * Returns a 2 byte buffer that represents the header of the bysquare
+ * specification
+ *
  * ```
  * | Attribute    | Number of bits | Possible values | Note
  * --------------------------------------------------------------------------------------------
@@ -10,38 +13,32 @@ import { Model } from "./index";
  * | Reserved     | 4              | 0-15            | bits reserved for future needs
  * ```
  *
- * @see {spec 3.5.}
+ * @see 3.5. by square header
  */
-export declare function createBysquareHeader(header?: [
+export declare function makeHeaderBysquare(header?: [
     bySquareType: number,
     version: number,
     documentType: number,
     reserved: number
 ]): Buffer;
-export declare function createChecksum(tabbedInput: string): Buffer;
 /**
- * Appending CRC32 checksum
- *
- * @see {spec 3.10.}
+ * @see 3.10 Appending CRC32 checksum
  */
-export declare function dataWithChecksum(model: Model): Buffer;
+export declare function makeChecksum(tabbedInput: string): Buffer;
 /**
- * Order keys by specification
- * Fill empty values
- * Transform to tabbed string
+ * Transfer object to a tabbed string and append a CRC32 checksum
+ *
+ * @see 3.10. Appending CRC32 checksum
  */
-export declare function createTabbedString(model: Model): string;
+export declare function prepareForCompression(model: Model): Buffer;
 /**
- * The bit sequence is split into 5 bit chunks which are mapped onto the
- * characters
+ * Convert object to tab-separated fields according to the sequence specification
  *
- * @see {spec 3.13. Table 9 – Encoding table}
+ * @see Table 15 PAY by square sequence data model
  */
-export declare const SUBST = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
+export declare function makeTabbed(model: Model): string;
 /**
- * Alphanumeric conversion using Base32hex
- *
- * @see {spec 3.13.}
+ * @see 3.13. Alphanumeric conversion using Base32hex
  */
 export declare function alphanumericConversion(data: Buffer): string;
 export declare function generate(model: Model): Promise<string>;

package/lib/generate.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -19,11 +23,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generate = exports.alphanumericConversion = exports.SUBST = exports.createTabbedString = exports.dataWithChecksum = exports.createChecksum = exports.createBysquareHeader = void 0;
+exports.generate = exports.alphanumericConversion = exports.makeTabbed = exports.prepareForCompression = exports.makeChecksum = exports.makeHeaderBysquare = void 0;
 const lzma = __importStar(require("lzma-native"));
 const index_1 = require("./index");
 // echo "Hello" | xz --format=raw --lzma1=lc=3,lp=0,pb=2,dict=32KiB --stdout | hexdump -C
 /**
+ * Returns a 2 byte buffer that represents the header of the bysquare
+ * specification
+ *
  * ```
  * | Attribute    | Number of bits | Possible values | Note
  * --------------------------------------------------------------------------------------------
@@ -33,11 +40,9 @@ const index_1 = require("./index");
  * | Reserved     | 4              | 0-15            | bits reserved for future needs
  * ```
  *
- * @see {spec 3.5.}
+ * @see 3.5. by square header
  */
-function createBysquareHeader(
-// prettier-ignore
-header = [
+function makeHeaderBysquare(header = [
     0b0000_0000, 0b0000_0000,
     0b0000_0000, 0b0000_0000
 ]) {
@@ -45,83 +50,96 @@ header = [
     if (!isValid) {
         throw new Error("Header range of values must be <0,15>");
     }
-    const [BySquareType, Version, DocumentType, Reserved] = header;
+    const [bySquareType, version, documentType, reserved] = header;
     /** Combine 4-nibbles to 2-bytes */
     const headerBuffer = Buffer.from([
-        (BySquareType << 4) | (Version << 0),
-        (DocumentType << 4) | (Reserved << 0)
+        (bySquareType << 4) | (version << 0),
+        (documentType << 4) | (reserved << 0)
     ]);
     return headerBuffer;
 }
-exports.createBysquareHeader = createBysquareHeader;
+exports.makeHeaderBysquare = makeHeaderBysquare;
 /**
- * LZMA Compression header
+ * Allocates a new buffer of a 2 bytes that represents LZMA header which
+ * contains 16-bit unsigned integer (word, little-endian), which is the size of
+ * the decompressed data. Therefore the maximum size of compressed data is
+ * limited to 65535
  *
- * @see {spec 3.11.}
+ * @see 3.11. LZMA Compression
  */
-function createCompresionHeader(byteLength) {
+function makeHeaderLzma(decompressedData) {
+    const bytesCount = decompressedData.length;
+    if (bytesCount >= 2 ** 16) {
+        throw new Error("The maximum compressed data size has been reached");
+    }
     const dataSize = Buffer.alloc(2);
-    dataSize.writeInt16LE(byteLength, 0);
+    dataSize.writeInt16LE(bytesCount);
     return dataSize;
 }
-function createChecksum(tabbedInput) {
+/**
+ * @see 3.10 Appending CRC32 checksum
+ */
+function makeChecksum(tabbedInput) {
     // @ts-ignore: Wrong return type
     const data = lzma.crc32(tabbedInput);
     const crc32 = Buffer.alloc(4);
     crc32.writeUInt32LE(data);
     return crc32;
 }
-exports.createChecksum = createChecksum;
+exports.makeChecksum = makeChecksum;
 /**
- * Appending CRC32 checksum
+ * Transfer object to a tabbed string and append a CRC32 checksum
  *
- * @see {spec 3.10.}
+ * @see 3.10. Appending CRC32 checksum
  */
-function dataWithChecksum(model) {
-    const tabbedString = createTabbedString(model);
-    const checksum = createChecksum(tabbedString);
-    const merged = Buffer.concat([
-        checksum,
-        Buffer.from(tabbedString, "utf-8")
+function prepareForCompression(model) {
+    const tabbed = makeTabbed(model);
+    return Buffer.concat([
+        makeChecksum(tabbed),
+        Buffer.from(tabbed, "utf-8")
     ]);
-    return merged;
 }
-exports.dataWithChecksum = dataWithChecksum;
+exports.prepareForCompression = prepareForCompression;
 /**
- * Order keys by specification
- * Fill empty values
- * Transform to tabbed string
+ * Convert object to tab-separated fields according to the sequence specification
+ *
+ * @see Table 15 PAY by square sequence data model
  */
-function createTabbedString(model) {
-    const tabbedModel = Object.keys(model)
-        .reduce((acc, key) => {
-        acc[index_1.ModelOrdered[key]] = String(model[key] ?? "");
+function makeTabbed(model) {
+    const tabbed = Object.keys(model).reduce((acc, key) => {
+        const index = index_1.SequenceOrder[key];
+        acc[index] = String(model[key]);
         return acc;
-    }, Array(33).fill(""))
-        .join("\t");
-    return tabbedModel;
+    }, Array(33).fill(undefined));
+    const notStandingOrder = tabbed[14] === undefined;
+    const notDirectDebit = tabbed[19] === undefined;
+    if (notStandingOrder) {
+        const attributesLength = 4;
+        tabbed[14] = String(0);
+        tabbed.splice(15, attributesLength);
+        if (notDirectDebit) {
+            tabbed[19 - attributesLength] = String(0);
+            tabbed.splice(20 - attributesLength, 10);
+        }
+        return tabbed.join("\t");
+    }
+    if (notDirectDebit) {
+        const attributesLength = 10;
+        tabbed[19] = String(0);
+        tabbed.splice(20, attributesLength);
+    }
+    return tabbed.join("\t");
 }
-exports.createTabbedString = createTabbedString;
-/**
- * The bit sequence is split into 5 bit chunks which are mapped onto the
- * characters
- *
- * @see {spec 3.13. Table 9 – Encoding table}
- */
-exports.SUBST = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
+exports.makeTabbed = makeTabbed;
 /**
- * Alphanumeric conversion using Base32hex
- *
- * @see {spec 3.13.}
+ * @see 3.13. Alphanumeric conversion using Base32hex
  */
 function alphanumericConversion(data) {
     let paddedBinString = data.reduce((acc, byte) => acc + byte.toString(2).padStart(8, "0"), "");
     let paddedLength = paddedBinString.length;
     const remainder = paddedLength % 5;
     if (remainder) {
-        paddedBinString += Array(5 - remainder)
-            .fill("0")
-            .join("");
+        paddedBinString += Array(5 - remainder).fill("0").join("");
         paddedLength += 5 - remainder;
     }
     /**
@@ -136,14 +154,14 @@ function alphanumericConversion(data) {
         const binEnd = 5 * i + 5;
         const sliced = paddedBinString.slice(binStart, binEnd);
         const key = parseInt(sliced, 2);
-        encoded += exports.SUBST[key];
+        encoded += index_1.SUBST[key];
     }
     return encoded;
 }
 exports.alphanumericConversion = alphanumericConversion;
 function generate(model) {
-    const dataBuffer = dataWithChecksum(model);
-    const dataChunks = [];
+    const data = prepareForCompression(model);
+    const compressedData = [];
     return new Promise((resolve, reject) => {
         const encoder = lzma.createStream("rawEncoder", {
             synchronous: true,
@@ -152,21 +170,19 @@ function generate(model) {
         });
         encoder
             .on("data", (chunk) => {
-            dataChunks.push(chunk);
+            compressedData.push(chunk);
         })
             .on("error", reject)
             .on("end", () => {
-            const headerBysquare = createBysquareHeader();
-            const headerCompression = createCompresionHeader(dataBuffer.byteLength);
-            const mergeData = Buffer.concat([
-                headerBysquare,
-                headerCompression,
-                ...dataChunks
+            const output = Buffer.concat([
+                makeHeaderBysquare(),
+                makeHeaderLzma(data),
+                ...compressedData
             ]);
-            const output = alphanumericConversion(mergeData);
-            resolve(output);
+            const qr = alphanumericConversion(output);
+            resolve(qr);
         })
-            .write(dataBuffer, (error) => {
+            .write(data, (error) => {
             error && reject(error);
             encoder.end();
         });

package/lib/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -11,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generate = exports.detect = exports.parse = void 0;
+// Library exposed functions and types
 var parse_1 = require("./parse");
 Object.defineProperty(exports, "parse", { enumerable: true, get: function () { return parse_1.parse; } });
 Object.defineProperty(exports, "detect", { enumerable: true, get: function () { return parse_1.detect; } });

package/lib/parse.d.ts

@@ -1,21 +1,15 @@
 /// <reference types="node" />
-import { Model } from ".";
+import { ParsedModel } from "./index";
 /**
- * Generating by square Code
- *
- * @see {spec 3.14.}
+ * @see 3.14. Generating by square Code
  */
-export declare function createModel(tabbedString: string): Model;
+export declare function assemble(tabbed: string): ParsedModel;
 /**
- * Decoding client data from QR Code 2005 symbol
- *
- * @see {spec 3.16.}
+ * @see 3.16. Decoding client data from QR Code 2005 symbol
  */
-export declare function parse(qr: string): Promise<Model>;
+export declare function parse(qr: string): Promise<ParsedModel>;
 /**
- * Reverse alphanumeric conversion using Base32hex
- *
- * @see {spec 3.13.}
+ * @see 3.13. Alphanumeric conversion using Base32hex
  */
 export declare function inverseAlphanumericConversion(qr: string): Buffer;
 /**

package/lib/parse.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -19,56 +23,128 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.detect = exports.inverseAlphanumericConversion = exports.parse = exports.createModel = void 0;
+exports.detect = exports.inverseAlphanumericConversion = exports.parse = exports.assemble = void 0;
 const lzma = __importStar(require("lzma-native"));
-const _1 = require(".");
-const generate_1 = require("./generate");
+const index_1 = require("./index");
+const FIELDS_INVOICE = 0;
+const FIELDS_NUMBER_OF_PAYMENTS = 1;
+const FIELDS_PAYMENT_OPTIONS = 2;
 /**
- * Generating by square Code
- *
- * @see {spec 3.14.}
+ * @see 3.14. Generating by square Code
  */
-function createModel(tabbedString) {
-    const model = tabbedString
+function assemble(tabbed) {
+    const fields = tabbed
         .split("\t")
-        .filter((ch) => !(ch === "\x00"))
-        .reduce((acc, value, i) => {
-        const key = _1.ModelOrdered[i];
-        if (value === "") {
-            return acc;
+        /** The end of the qr-string might contain a NULL-terminated string */
+        .map((entry) => entry.replace("\x00", ""));
+    const invoiceId = fields[FIELDS_INVOICE];
+    const output = {
+        invoiceId: !!invoiceId.length ? invoiceId : undefined,
+        payments: []
+    };
+    const paymentsCount = Number(fields[FIELDS_NUMBER_OF_PAYMENTS]);
+    const paymentOptions = Number(fields[FIELDS_PAYMENT_OPTIONS]);
+    for (let i = 0; i < paymentsCount; i++) {
+        const payment = fields.slice(3 + i, 11 + i);
+        const [ammount, currencyCode, paymentDueDate, variableSymbol, constantSymbol, specificSymbol, originatorsReferenceInformation, paymentNote] = payment;
+        output.payments.push({
+            amount: ammount.length ? Number(ammount) : undefined,
+            currencyCode: currencyCode,
+            paymentDueDate: paymentDueDate?.length ? paymentDueDate : undefined,
+            variableSymbol: variableSymbol?.length ? variableSymbol : undefined,
+            constantSymbol: constantSymbol?.length ? constantSymbol : undefined,
+            specificSymbol: specificSymbol?.length ? specificSymbol : undefined,
+            originatorsReferenceInformation: originatorsReferenceInformation?.length ? originatorsReferenceInformation : undefined,
+            paymentNote: paymentNote?.length ? paymentNote : undefined,
+            bankAccounts: []
+        });
+        const bankAccounts = fields.slice(11 + i, 15 + i);
+        const [bankAccountsCount, iban, bic] = bankAccounts;
+        if (bankAccountsCount?.length === 0) {
+            throw new Error("Missing bank accounts count");
         }
-        const numericKeys = [
-            "Payments",
-            "PaymentOptions",
-            "Amount",
-            "BankAccounts",
-            "StandingOrderExt",
-            "Day",
-            "Month",
-            "DirectDebitExt",
-            "DirectDebitScheme",
-            "DirectDebitType",
-            "MaxAmount"
-        ];
-        if (numericKeys.includes(key)) {
-            acc[key] = Number(value);
-            return acc;
+        if (iban?.length === 0) {
+            throw new Error("Missing IBAN");
         }
-        acc[key] = value;
-        return acc;
-    }, {});
-    return model;
+        for (let j = 0; j < Number(bankAccountsCount); j++) {
+            output.payments[i].bankAccounts.push({
+                iban: iban,
+                bic: bic?.length ? bic : undefined
+            });
+        }
+        switch (paymentOptions) {
+            case index_1.PaymentOptions.PaymentOrder:
+                break;
+            case index_1.PaymentOptions.StandingOrder:
+                const standingOrder = fields.slice(15 + i, 20 + i);
+                const [day, month, periodicity, lastDate] = standingOrder;
+                output.payments[i].standingOrder = {
+                    day: day?.length ? Number(day) : undefined,
+                    month: month?.length ? Number(month) : undefined,
+                    periodicity: periodicity?.length ? periodicity : undefined,
+                    lastDate: lastDate?.length ? lastDate : undefined
+                };
+                break;
+            case index_1.PaymentOptions.DirectDebit:
+                const directDebit = fields.slice(16 + i, 26 + i);
+                const [directDebitScheme, directDebitType, variableSymbol, specificSymbol, originatorsReferenceInformation, mandateId, creditorId, contractId, maxAmount, validTillDate,] = directDebit;
+                output.payments[i].directDebit = {
+                    directDebitScheme: directDebitScheme.length ? Number(directDebitScheme) : undefined,
+                    directDebitType: directDebitType.length ? Number(directDebitType) : undefined,
+                    variableSymbol: variableSymbol.length ? variableSymbol : undefined,
+                    specificSymbol: specificSymbol.length ? specificSymbol : undefined,
+                    originatorsReferenceInformation: originatorsReferenceInformation.length ? originatorsReferenceInformation : undefined,
+                    mandateId: mandateId.length ? mandateId : undefined,
+                    creditorId: creditorId.length ? creditorId : undefined,
+                    contractId: contractId.length ? contractId : undefined,
+                    maxAmount: maxAmount.length ? Number(maxAmount) : undefined,
+                    validTillDate: validTillDate.length ? validTillDate : undefined
+                };
+            default:
+                throw new Error("Unknown payment option");
+        }
+    }
+    /** Beneficiary list bysquare v1.1 */
+    for (let i = 0; i < paymentsCount; i++) {
+        let beneficiary = [];
+        switch (paymentOptions) {
+            case index_1.PaymentOptions.PaymentOrder:
+                beneficiary = fields.slice(16 + i, 20 + i);
+                break;
+            case index_1.PaymentOptions.StandingOrder:
+                beneficiary = fields.slice(20 + i, 24 + i);
+                break;
+            case index_1.PaymentOptions.DirectDebit:
+                beneficiary = fields.slice(25 + i, 29 + i);
+                break;
+        }
+        if (beneficiary.length === 0) {
+            break;
+        }
+        const [name, addressLine1, addressLine2] = beneficiary;
+        /**
+         * The list of recipients is optional, if we find a missing record, the
+         * stream ends
+         */
+        if (!name && !addressLine1 && !addressLine2) {
+            break;
+        }
+        output.payments[i].beneficiary = {
+            name: name?.length ? name : undefined,
+            addressLine1: addressLine1?.length ? addressLine1 : undefined,
+            addressLine2: addressLine2?.length ? addressLine2 : undefined
+        };
+    }
+    return output;
 }
-exports.createModel = createModel;
+exports.assemble = assemble;
 /**
- * Decoding client data from QR Code 2005 symbol
- *
- * @see {spec 3.16.}
+ * @see 3.16. Decoding client data from QR Code 2005 symbol
  */
 function parse(qr) {
     const inversed = inverseAlphanumericConversion(qr);
-    const headerBysquare = inversed.slice(0, 2);
-    const headerCompression = inversed.slice(2, 4);
+    const _headerBysquare = inversed.slice(0, 2);
+    const _headerCompression = inversed.slice(2, 4);
     const compressedData = inversed.slice(4);
     // @ts-ignore: Missing decored types
     const decoder = lzma.createStream("rawDecoder", {
@@ -81,8 +157,8 @@ function parse(qr) {
             .on("error", reject)
             .on("data", (decompress) => {
             const _crc32 = decompress.slice(0, 4);
-            const data = decompress.slice(4).toString();
-            const model = createModel(data);
+            const tabbed = decompress.slice(4).toString();
+            const model = assemble(tabbed);
             resolve(model);
         })
             .write(compressedData, (error) => {
@@ -93,13 +169,11 @@ function parse(qr) {
 }
 exports.parse = parse;
 /**
- * Reverse alphanumeric conversion using Base32hex
- *
- * @see {spec 3.13.}
+ * @see 3.13. Alphanumeric conversion using Base32hex
  */
 function inverseAlphanumericConversion(qr) {
     const binary = [...qr].reduce((acc, char) => {
-        acc += generate_1.SUBST.indexOf(char).toString(2).padStart(5, "0");
+        acc += index_1.SUBST.indexOf(char).toString(2).padStart(5, "0");
         return acc;
     }, "");
     let bytes = [];
@@ -127,9 +201,8 @@ function detect(qr) {
     return [...headerBysquare.toString("hex")]
         .map((nibble) => parseInt(nibble, 16))
         .every((nibble, index) => {
-        // check version, actual v1.x.x
-        if (index === 1) {
-            return nibble <= 2;
+        if (index === 1 /** version */) {
+            return 0 >= nibble && nibble <= 1;
         }
         return 0 <= nibble && nibble <= 15;
     });

package/lib/types.d.ts

@@ -1,3 +1,47 @@
+/**
+ * The bit sequence is split into 5 bit chunks which are mapped onto the
+ * characters
+ *
+ * @see {spec 3.13. Table 9 – Encoding table}
+ */
+export declare const SUBST = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
+export declare enum PaymentOptions {
+    PaymentOrder = 1,
+    StandingOrder = 2,
+    DirectDebit = 3
+}
+export declare enum MonthClassifier {
+    January = 1,
+    February = 2,
+    March = 4,
+    April = 8,
+    May = 16,
+    June = 32,
+    July = 64,
+    August = 128,
+    September = 256,
+    October = 512,
+    November = 1024,
+    December = 2048
+}
+export declare enum PeriodicityClassifier {
+    Daily = "d",
+    Weekly = "w",
+    Biweekly = "b",
+    Monthly = "m",
+    Bimonthly = "B",
+    Quarterly = "q",
+    Semiannually = "s",
+    Annually = "a"
+}
+export declare enum DirectDebitType {
+    OneOff = 0,
+    Recurrent = 1
+}
+export declare enum DirectDebitScheme {
+    Other = 0,
+    Sepa = 1
+}
 /**
  * Table 15. PAY by square sequence data model (page 30.)
  */
@@ -7,32 +51,28 @@ export interface Model {
      */
     InvoiceID?: string;
     /**
+     * Appendix E extended beneficiary fields
+     * Table 16 PAY by square extended fields for bulk payment order
+     *
      * Number of payments
      */
     Payments: number;
     /**
      * Max length 1
      */
-    PaymentOptions: number;
+    PaymentOptions: PaymentOptions;
     /**
      * Encoded with amount payable. This field is not required and can be left
      * blank in cases payment amount is not known ­such as donations.
      *
-     * Max length 15
-     * Format #.########
+     * Decimal, max length 15
      */
     Amount?: number;
     /**
      * 3 letter, payment currency code according to ISO 4217
-     *
-     * Max length 3
-     * Representation ISO 4217
      */
     CurrencyCode: keyof typeof CurrencyCode;
     /**
-     * Optional field
-     *
-     * Max length 8
      * Format YYYYMMDD
      */
     PaymentDueDate?: string;
@@ -77,7 +117,7 @@ export interface Model {
     /**
      * Max length 1
      */
-    StandingOrderExt?: number;
+    StandingOrderExt?: 0 | 1;
     /**
      * This is the payment day. It‘s meaning depends on the periodicity, meaning
      * either day of the month (number between 1 and 31) or day of the week
@@ -93,7 +133,7 @@ export interface Model {
      *
      * Max length 4
      */
-    Month?: number;
+    Month?: MonthClassifier;
     /**
      * Periodicity of the payment. All valid options are „Daily“, „Weekly“,
      * „Biweekly“, „Monthly“, „Bimonthly“, „Quarterly“, „Annually“,
@@ -102,33 +142,44 @@ export interface Model {
      *
      * Max length 1
      */
-    Periodicity?: string;
+    Periodicity?: PeriodicityClassifier;
     /**
      * Defines the day of the last payment of the standing order. After this
      * date, standing order is cancelled.
      *
-     * Max length 8
      * Format YYYYMMDD
      */
     LastDate?: string;
     /**
      * Max length 1
      */
-    DirectDebitExt?: number;
+    DirectDebitExt?: 0 | 1;
     /**
-     * This field can have “SEPA” value, if direct debit is using SEPA direct
-     * debit scheme or “other” when an ordinary direct debit is defined
+     * 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.
      *
      * Max length 1
      */
-    DirectDebitScheme?: number;
+    DirectDebitScheme?: DirectDebitScheme;
     /**
      * Can be „one­off“ for one time debit or „recurrent“ for repeated debit
      * until cancelled.
      *
      * Max length 1
      */
-    DirectDebitType?: number;
+    DirectDebitType?: DirectDebitType;
     /**
      * Max length 10
      */
@@ -155,10 +206,9 @@ export interface Model {
     ContractID?: string;
     /**
      * Optional field. As most users prefer to set up some maximum amount for
-     * the direct debit, this can be pre­filled for them.
+     * the direct debit, this can be pre­-filled for them.
      *
-     * Max length 15
-     * Format #.########
+     * Decimal, max length 15
      */
     MaxAmount?: number;
     /**
@@ -169,24 +219,71 @@ export interface Model {
      */
     ValidTillDate?: string;
     /**
+     * Belongs to the first payment
+     *
      * Max length 70
      */
     BeneficiaryName?: string;
     /**
+     * Belongs to the first payment
+     *
      * Max length 70
      */
     BeneficiaryAddressLine1?: string;
     /**
+     * Belongs to the first payment
+     *
      * Max length 70
      */
     BeneficiaryAddressLine2?: string;
 }
+export interface ParsedModel {
+    invoiceId: Model["InvoiceID"];
+    payments: Array<{
+        amount: Model["Amount"];
+        currencyCode: Model["CurrencyCode"];
+        paymentDueDate?: Model["PaymentDueDate"];
+        variableSymbol?: Model["VariableSymbol"];
+        constantSymbol?: Model["ConstantSymbol"];
+        specificSymbol?: Model["SpecificSymbol"];
+        originatorsReferenceInformation?: Model["OriginatorsReferenceInformation"];
+        paymentNote?: Model["PaymentNote"];
+        bankAccounts: Array<{
+            iban: Model["IBAN"];
+            bic?: Model["BIC"];
+        }>;
+        standingOrder?: {
+            day?: Model["Day"];
+            month?: Model["Month"];
+            periodicity?: Model["Periodicity"];
+            lastDate?: Model["LastDate"];
+        };
+        directDebit?: {
+            directDebitScheme?: Model["DirectDebitScheme"];
+            directDebitType?: Model["DirectDebitType"];
+            variableSymbol?: Model["VariableSymbol"];
+            specificSymbol?: Model["SpecificSymbol"];
+            originatorsReferenceInformation?: Model["OriginatorsReferenceInformation_"];
+            mandateId?: Model["MandateID"];
+            creditorId?: Model["CreditorID"];
+            contractId?: Model["ContractID"];
+            maxAmount?: Model["MaxAmount"];
+            validTillDate?: Model["ValidTillDate"];
+        };
+        beneficiary?: {
+            name?: Model["BeneficiaryName"];
+            addressLine1?: Model["BeneficiaryAddressLine1"];
+            addressLine2?: Model["BeneficiaryAddressLine2"];
+        };
+    }>;
+}
 /**
  * Atributes must follow specific order
  * Based on Table 15. PAY by square sequence data model (page 30.)
+ *
  * @see{./docs/specification_v1.1.0.pdf}
  */
-export declare enum ModelOrdered {
+export declare enum SequenceOrder {
     InvoiceID = 0,
     Payments = 1,
     PaymentOptions = 2,

package/lib/types.js

@@ -1,47 +1,116 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CurrencyCode = exports.ModelOrdered = void 0;
+exports.CurrencyCode = exports.SequenceOrder = exports.DirectDebitScheme = exports.DirectDebitType = exports.PeriodicityClassifier = exports.MonthClassifier = exports.PaymentOptions = exports.SUBST = void 0;
+/**
+ * The bit sequence is split into 5 bit chunks which are mapped onto the
+ * characters
+ *
+ * @see {spec 3.13. Table 9 – Encoding table}
+ */
+exports.SUBST = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
+/**
+ * Mapping semantic version to encoded version number, header 4-bits
+ *
+ * It's a bit silly to limit the version number to 4-bit, if they keep
+ * increasing the version number, the latest possible mapped value is 16
+ */
+var Version;
+(function (Version) {
+    /**
+     * 2013-02-22
+     * Created this document from original by square specifications
+     */
+    Version[Version["1.0.0"] = 0] = "1.0.0";
+    /**
+     * 2015-06-24
+     * Added fields for beneficiary name and address
+     */
+    Version[Version["1.1.0"] = 1] = "1.1.0";
+})(Version || (Version = {}));
+var PaymentOptions;
+(function (PaymentOptions) {
+    PaymentOptions[PaymentOptions["PaymentOrder"] = 1] = "PaymentOrder";
+    PaymentOptions[PaymentOptions["StandingOrder"] = 2] = "StandingOrder";
+    PaymentOptions[PaymentOptions["DirectDebit"] = 3] = "DirectDebit";
+})(PaymentOptions = exports.PaymentOptions || (exports.PaymentOptions = {}));
+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 = {}));
+var PeriodicityClassifier;
+(function (PeriodicityClassifier) {
+    PeriodicityClassifier["Daily"] = "d";
+    PeriodicityClassifier["Weekly"] = "w";
+    PeriodicityClassifier["Biweekly"] = "b";
+    PeriodicityClassifier["Monthly"] = "m";
+    PeriodicityClassifier["Bimonthly"] = "B";
+    PeriodicityClassifier["Quarterly"] = "q";
+    PeriodicityClassifier["Semiannually"] = "s";
+    PeriodicityClassifier["Annually"] = "a";
+})(PeriodicityClassifier = exports.PeriodicityClassifier || (exports.PeriodicityClassifier = {}));
+var DirectDebitType;
+(function (DirectDebitType) {
+    DirectDebitType[DirectDebitType["OneOff"] = 0] = "OneOff";
+    DirectDebitType[DirectDebitType["Recurrent"] = 1] = "Recurrent";
+})(DirectDebitType = exports.DirectDebitType || (exports.DirectDebitType = {}));
+var DirectDebitScheme;
+(function (DirectDebitScheme) {
+    DirectDebitScheme[DirectDebitScheme["Other"] = 0] = "Other";
+    DirectDebitScheme[DirectDebitScheme["Sepa"] = 1] = "Sepa";
+})(DirectDebitScheme = exports.DirectDebitScheme || (exports.DirectDebitScheme = {}));
 /**
  * Atributes must follow specific order
  * Based on Table 15. PAY by square sequence data model (page 30.)
+ *
  * @see{./docs/specification_v1.1.0.pdf}
  */
-var ModelOrdered;
-(function (ModelOrdered) {
-    ModelOrdered[ModelOrdered["InvoiceID"] = 0] = "InvoiceID";
-    ModelOrdered[ModelOrdered["Payments"] = 1] = "Payments";
-    ModelOrdered[ModelOrdered["PaymentOptions"] = 2] = "PaymentOptions";
-    ModelOrdered[ModelOrdered["Amount"] = 3] = "Amount";
-    ModelOrdered[ModelOrdered["CurrencyCode"] = 4] = "CurrencyCode";
-    ModelOrdered[ModelOrdered["PaymentDueDate"] = 5] = "PaymentDueDate";
-    ModelOrdered[ModelOrdered["VariableSymbol"] = 6] = "VariableSymbol";
-    ModelOrdered[ModelOrdered["ConstantSymbol"] = 7] = "ConstantSymbol";
-    ModelOrdered[ModelOrdered["SpecificSymbol"] = 8] = "SpecificSymbol";
-    ModelOrdered[ModelOrdered["OriginatorsReferenceInformation"] = 9] = "OriginatorsReferenceInformation";
-    ModelOrdered[ModelOrdered["PaymentNote"] = 10] = "PaymentNote";
-    ModelOrdered[ModelOrdered["BankAccounts"] = 11] = "BankAccounts";
-    ModelOrdered[ModelOrdered["IBAN"] = 12] = "IBAN";
-    ModelOrdered[ModelOrdered["BIC"] = 13] = "BIC";
-    ModelOrdered[ModelOrdered["StandingOrderExt"] = 14] = "StandingOrderExt";
-    ModelOrdered[ModelOrdered["Day"] = 15] = "Day";
-    ModelOrdered[ModelOrdered["Month"] = 16] = "Month";
-    ModelOrdered[ModelOrdered["Periodicity"] = 17] = "Periodicity";
-    ModelOrdered[ModelOrdered["LastDate"] = 18] = "LastDate";
-    ModelOrdered[ModelOrdered["DirectDebitExt"] = 19] = "DirectDebitExt";
-    ModelOrdered[ModelOrdered["DirectDebitScheme"] = 20] = "DirectDebitScheme";
-    ModelOrdered[ModelOrdered["DirectDebitType"] = 21] = "DirectDebitType";
-    ModelOrdered[ModelOrdered["VariableSymbol_"] = 22] = "VariableSymbol_";
-    ModelOrdered[ModelOrdered["SpecificSymbol_"] = 23] = "SpecificSymbol_";
-    ModelOrdered[ModelOrdered["OriginatorsReferenceInformation_"] = 24] = "OriginatorsReferenceInformation_";
-    ModelOrdered[ModelOrdered["MandateID"] = 25] = "MandateID";
-    ModelOrdered[ModelOrdered["CreditorID"] = 26] = "CreditorID";
-    ModelOrdered[ModelOrdered["ContractID"] = 27] = "ContractID";
-    ModelOrdered[ModelOrdered["MaxAmount"] = 28] = "MaxAmount";
-    ModelOrdered[ModelOrdered["ValidTillDate"] = 29] = "ValidTillDate";
-    ModelOrdered[ModelOrdered["BeneficiaryName"] = 30] = "BeneficiaryName";
-    ModelOrdered[ModelOrdered["BeneficiaryAddressLine1"] = 31] = "BeneficiaryAddressLine1";
-    ModelOrdered[ModelOrdered["BeneficiaryAddressLine2"] = 32] = "BeneficiaryAddressLine2";
-})(ModelOrdered = exports.ModelOrdered || (exports.ModelOrdered = {}));
+var SequenceOrder;
+(function (SequenceOrder) {
+    SequenceOrder[SequenceOrder["InvoiceID"] = 0] = "InvoiceID";
+    SequenceOrder[SequenceOrder["Payments"] = 1] = "Payments";
+    SequenceOrder[SequenceOrder["PaymentOptions"] = 2] = "PaymentOptions";
+    SequenceOrder[SequenceOrder["Amount"] = 3] = "Amount";
+    SequenceOrder[SequenceOrder["CurrencyCode"] = 4] = "CurrencyCode";
+    SequenceOrder[SequenceOrder["PaymentDueDate"] = 5] = "PaymentDueDate";
+    SequenceOrder[SequenceOrder["VariableSymbol"] = 6] = "VariableSymbol";
+    SequenceOrder[SequenceOrder["ConstantSymbol"] = 7] = "ConstantSymbol";
+    SequenceOrder[SequenceOrder["SpecificSymbol"] = 8] = "SpecificSymbol";
+    SequenceOrder[SequenceOrder["OriginatorsReferenceInformation"] = 9] = "OriginatorsReferenceInformation";
+    SequenceOrder[SequenceOrder["PaymentNote"] = 10] = "PaymentNote";
+    SequenceOrder[SequenceOrder["BankAccounts"] = 11] = "BankAccounts";
+    SequenceOrder[SequenceOrder["IBAN"] = 12] = "IBAN";
+    SequenceOrder[SequenceOrder["BIC"] = 13] = "BIC";
+    SequenceOrder[SequenceOrder["StandingOrderExt"] = 14] = "StandingOrderExt";
+    SequenceOrder[SequenceOrder["Day"] = 15] = "Day";
+    SequenceOrder[SequenceOrder["Month"] = 16] = "Month";
+    SequenceOrder[SequenceOrder["Periodicity"] = 17] = "Periodicity";
+    SequenceOrder[SequenceOrder["LastDate"] = 18] = "LastDate";
+    SequenceOrder[SequenceOrder["DirectDebitExt"] = 19] = "DirectDebitExt";
+    SequenceOrder[SequenceOrder["DirectDebitScheme"] = 20] = "DirectDebitScheme";
+    SequenceOrder[SequenceOrder["DirectDebitType"] = 21] = "DirectDebitType";
+    SequenceOrder[SequenceOrder["VariableSymbol_"] = 22] = "VariableSymbol_";
+    SequenceOrder[SequenceOrder["SpecificSymbol_"] = 23] = "SpecificSymbol_";
+    SequenceOrder[SequenceOrder["OriginatorsReferenceInformation_"] = 24] = "OriginatorsReferenceInformation_";
+    SequenceOrder[SequenceOrder["MandateID"] = 25] = "MandateID";
+    SequenceOrder[SequenceOrder["CreditorID"] = 26] = "CreditorID";
+    SequenceOrder[SequenceOrder["ContractID"] = 27] = "ContractID";
+    SequenceOrder[SequenceOrder["MaxAmount"] = 28] = "MaxAmount";
+    SequenceOrder[SequenceOrder["ValidTillDate"] = 29] = "ValidTillDate";
+    SequenceOrder[SequenceOrder["BeneficiaryName"] = 30] = "BeneficiaryName";
+    SequenceOrder[SequenceOrder["BeneficiaryAddressLine1"] = 31] = "BeneficiaryAddressLine1";
+    SequenceOrder[SequenceOrder["BeneficiaryAddressLine2"] = 32] = "BeneficiaryAddressLine2";
+})(SequenceOrder = exports.SequenceOrder || (exports.SequenceOrder = {}));
 /**
  * Currency codes based on ISO 4217
  */

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": "1.2.2",
+	"version": "1.3.0",
 	"license": "Apache-2.0",
 	"author": "Filip Seman <filip.seman@protonmail.com>",
 	"keywords": [
@@ -38,8 +38,8 @@
 	},
 	"devDependencies": {
 		"@types/lzma-native": "^4.0.1",
-		"@types/node": ">= 14.x.x",
-		"typescript": "4.5.5",
+		"@types/node": ">=14",
+		"typescript": "~4.7.0",
 		"vitest": "0.22.0"
 	},
 	"files": [
@@ -50,8 +50,8 @@
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
 	"engines": {
-		"node": ">=14.x.x",
-		"npm": ">= 7.0"
+		"node": ">=14",
+		"npm": ">=7.0"
 	},
 	"os": [
 		"darwin",