bysquare 1.2.1 → 1.2.2

package/README.md

@@ -39,7 +39,7 @@ npm install --global bysquare
 
 ### **generate(model: Model): Promise\<string>**
 
-```typescript
+```ts
 import { generate, Model, parse } from "bysquare"
 
 const model: Model = {
@@ -58,9 +58,9 @@ generate(model).then((qrString: string) => {
 })
 ```
 
-### **parse(qrString: string): Promise\<Model>**
+### **parse(qr: string): Promise\<Model>**
 
-```typescript
+```ts
 import { Model, parse } from "bysquare"
 
 const qrString = "0004G0005ES17OQ09C98Q7ME34TCR3V71LVKD2AE6EGHKR82DKS5NBJ3331VUFQIV0JGMR743UJCKSAKEM9QGVVVOIVH000"
@@ -70,6 +70,17 @@ parse(qrString).then((model: Model) => {
 })
 ```
 
+### **detect(qr: string): Boolean**
+
+```ts
+import { detect } from "bysquare"
+
+const qrString = "0004G0005ES17OQ09C98Q7ME34TCR3V71LVKD2AE6EGHKR82DKS5NBJ3331VUFQIV0JGMR743UJCKSAKEM9QGVVVOIVH000"
+const isBysquare = detect(qrString)
+
+// your logic...
+```
+
 ## CLI
 
 You can use json file with valid model to generate qr-string.
@@ -86,25 +97,23 @@ You can use json file with valid model to generate qr-string.
 #     "BankAccounts": 1
 # }
 
-> npx bysquare ./example.json
-> 0004G0005ES17OQ09C98Q7ME34TCR3V71LVKD2AE6EGHKR82DKS5NBJ3331VUFQIV0JGMR743UJCKSAKEM9QGVVVOIVH000
+$ npx bysquare ./example.json
+$ 0004G0005ES17OQ09C98Q7ME34TCR3V71LVKD2AE6EGHKR82DKS5NBJ3331VUFQIV0JGMR743UJCKSAKEM9QGVVVOIVH000
 ```
 
 You can also use stdin.
 
 ```sh
-> echo '
-    {
-        "IBAN": "SK9611000000002918599669",
-        "Amount": 100.0,
-        "CurrencyCode": "EUR",
-        "VariableSymbol": "123",
-        "Payments": 1,
-        "PaymentOptions": 1,
-        "BankAccounts": 1
-    }' \
-| bysquare
-> 0004G0005ES17OQ09C98Q7ME34TCR3V71LVKD2AE6EGHKR82DKS5NBJ3331VUFQIV0JGMR743UJCKSAKEM9QGVVVOIVH000
+$ bysquare <<< '{
+	"IBAN": "SK9611000000002918599669",
+	"Amount": 100.0,
+	"CurrencyCode": "EUR",
+	"VariableSymbol": "123",
+	"Payments": 1,
+	"PaymentOptions": 1,
+	"BankAccounts": 1
+}'
+$ 0004G0005ES17OQ09C98Q7ME34TCR3V71LVKD2AE6EGHKR82DKS5NBJ3331VUFQIV0JGMR743UJCKSAKEM9QGVVVOIVH000
 ```
 
 ## Model
@@ -173,6 +182,7 @@ Versioning
 - Commit and tag
 - Run the `postversion` script
 - Checkout to master
-- Push commits and tag, git push, git push --tags
+- Push commits and tag, git push && git push --tags
+- npm publish --dry-run
 - Publish to npm, npm publish
 -->

package/lib/cli.js

@@ -7,7 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
 const readline_1 = require("readline");
-const generate_1 = __importDefault(require("./generate"));
+const generate_1 = require("./generate");
 if (process.stdin.isTTY) {
     /** bysquare "file" */
     handleInput(process.argv[2]);
@@ -47,7 +47,7 @@ async function jsonStringToQrString(stdin) {
     return new Promise((resolve, reject) => {
         try {
             const data = JSON.parse(stdin);
-            const qrString = (0, generate_1.default)(data);
+            const qrString = (0, generate_1.generate)(data);
             resolve(qrString);
         }
         catch (e) {

package/lib/generate.d.ts

@@ -1,3 +1,47 @@
-import { Model } from ".";
-declare function generate(model: Model): Promise<string>;
-export default generate;
+/// <reference types="node" />
+import { Model } from "./index";
+/**
+ * ```
+ * | Attribute    | Number of bits | Possible values | Note
+ * --------------------------------------------------------------------------------------------
+ * | BySquareType | 4              | 0-15            | by square type
+ * | Version      | 4              | 0-15            | version of the by square type
+ * | DocumentType | 4              | 0-15            | document type within given by square type
+ * | Reserved     | 4              | 0-15            | bits reserved for future needs
+ * ```
+ *
+ * @see {spec 3.5.}
+ */
+export declare function createBysquareHeader(header?: [
+    bySquareType: number,
+    version: number,
+    documentType: number,
+    reserved: number
+]): Buffer;
+export declare function createChecksum(tabbedInput: string): Buffer;
+/**
+ * Appending CRC32 checksum
+ *
+ * @see {spec 3.10.}
+ */
+export declare function dataWithChecksum(model: Model): Buffer;
+/**
+ * Order keys by specification
+ * Fill empty values
+ * Transform to tabbed string
+ */
+export declare function createTabbedString(model: Model): string;
+/**
+ * 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";
+/**
+ * Alphanumeric conversion using Base32hex
+ *
+ * @see {spec 3.13.}
+ */
+export declare function alphanumericConversion(data: Buffer): string;
+export declare function generate(model: Model): Promise<string>;

package/lib/generate.js

@@ -1,18 +1,154 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+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]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const lzma_native_1 = __importDefault(require("lzma-native"));
-const utils_1 = require("./utils");
+exports.generate = exports.alphanumericConversion = exports.SUBST = exports.createTabbedString = exports.dataWithChecksum = exports.createChecksum = exports.createBysquareHeader = 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
+/**
+ * ```
+ * | Attribute    | Number of bits | Possible values | Note
+ * --------------------------------------------------------------------------------------------
+ * | BySquareType | 4              | 0-15            | by square type
+ * | Version      | 4              | 0-15            | version of the by square type
+ * | DocumentType | 4              | 0-15            | document type within given by square type
+ * | Reserved     | 4              | 0-15            | bits reserved for future needs
+ * ```
+ *
+ * @see {spec 3.5.}
+ */
+function createBysquareHeader(
+// prettier-ignore
+header = [
+    0b0000_0000, 0b0000_0000,
+    0b0000_0000, 0b0000_0000
+]) {
+    const isValid = header.every((nibble) => 0 <= nibble && nibble <= 15);
+    if (!isValid) {
+        throw new Error("Header range of values must be <0,15>");
+    }
+    const [BySquareType, Version, DocumentType, Reserved] = header;
+    /** Combine 4-nibbles to 2-bytes */
+    const headerBuffer = Buffer.from([
+        (BySquareType << 4) | (Version << 0),
+        (DocumentType << 4) | (Reserved << 0)
+    ]);
+    return headerBuffer;
+}
+exports.createBysquareHeader = createBysquareHeader;
+/**
+ * LZMA Compression header
+ *
+ * @see {spec 3.11.}
+ */
+function createCompresionHeader(byteLength) {
+    const dataSize = Buffer.alloc(2);
+    dataSize.writeInt16LE(byteLength, 0);
+    return dataSize;
+}
+function createChecksum(tabbedInput) {
+    // @ts-ignore: Wrong return type
+    const data = lzma.crc32(tabbedInput);
+    const crc32 = Buffer.alloc(4);
+    crc32.writeUInt32LE(data);
+    return crc32;
+}
+exports.createChecksum = createChecksum;
+/**
+ * Appending CRC32 checksum
+ *
+ * @see {spec 3.10.}
+ */
+function dataWithChecksum(model) {
+    const tabbedString = createTabbedString(model);
+    const checksum = createChecksum(tabbedString);
+    const merged = Buffer.concat([
+        checksum,
+        Buffer.from(tabbedString, "utf-8")
+    ]);
+    return merged;
+}
+exports.dataWithChecksum = dataWithChecksum;
+/**
+ * Order keys by specification
+ * Fill empty values
+ * Transform to tabbed string
+ */
+function createTabbedString(model) {
+    const tabbedModel = Object.keys(model)
+        .reduce((acc, key) => {
+        acc[index_1.ModelOrdered[key]] = String(model[key] ?? "");
+        return acc;
+    }, Array(33).fill(""))
+        .join("\t");
+    return tabbedModel;
+}
+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";
+/**
+ * Alphanumeric conversion using Base32hex
+ *
+ * @see {spec 3.13.}
+ */
+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("");
+        paddedLength += 5 - remainder;
+    }
+    /**
+     * Map a binary number of 5 bits to a string representation 2^5
+     * SUBST[0...32] represents char
+     *
+     * @see {@link SUBST}
+     */
+    let encoded = "";
+    for (let i = 0; i < paddedLength / 5; i++) {
+        const binStart = 5 * i;
+        const binEnd = 5 * i + 5;
+        const sliced = paddedBinString.slice(binStart, binEnd);
+        const key = parseInt(sliced, 2);
+        encoded += exports.SUBST[key];
+    }
+    return encoded;
+}
+exports.alphanumericConversion = alphanumericConversion;
 function generate(model) {
-    const dataBuffer = (0, utils_1.dataWithChecksum)(model);
+    const dataBuffer = dataWithChecksum(model);
     const dataChunks = [];
     return new Promise((resolve, reject) => {
-        const encoder = lzma_native_1.default.createStream("rawEncoder", {
+        const encoder = lzma.createStream("rawEncoder", {
             synchronous: true,
             // @ts-ignore: Missing filter types
-            filters: [{ id: lzma_native_1.default.FILTER_LZMA1 }]
+            filters: [{ id: lzma.FILTER_LZMA1 }]
         });
         encoder
             .on("data", (chunk) => {
@@ -20,50 +156,20 @@ function generate(model) {
         })
             .on("error", reject)
             .on("end", () => {
-            /**
-             * The header of compressed data is 2 bytes long and contains only
-             * one 16­bit unsigned integer (word, little­endian), which is the
-             * size of the decompressed data (spec 3.11)
-             */
-            const size = Buffer.alloc(2);
-            size.writeInt16LE(dataBuffer.byteLength, 0);
-            /** (spec 3.5) */
-            const header = (0, utils_1.createHeader)();
-            /** Merged binary data (spec 3.15.) */
-            const merged = Buffer.concat([
-                header,
-                size,
-                Buffer.concat(dataChunks)
+            const headerBysquare = createBysquareHeader();
+            const headerCompression = createCompresionHeader(dataBuffer.byteLength);
+            const mergeData = Buffer.concat([
+                headerBysquare,
+                headerCompression,
+                ...dataChunks
             ]);
-            let paddedBinString = merged.reduce((acc, byte) => acc + byte.toString(2).padStart(8, "0"), "");
-            let paddedBinLength = paddedBinString.length;
-            const remainder = paddedBinLength % 5;
-            if (remainder) {
-                paddedBinString += Array(5 - remainder)
-                    .fill("0")
-                    .join("");
-                paddedBinLength += 5 - remainder;
-            }
-            /**
-             * Map a binary number of 5 bits to a string representation 2^5
-             * '0123456789ABCDEFGHIJKLMNOPQRSTUV'[0...32] represents char
-             */
-            let output = "";
-            for (let i = 0; i < paddedBinLength / 5; i++) {
-                const binStart = 5 * i;
-                const binEnd = 5 * i + 5;
-                const slice = paddedBinString.slice(binStart, binEnd);
-                const key = parseInt(slice, 2);
-                output += utils_1.SUBST[key];
-            }
-            return resolve(output);
+            const output = alphanumericConversion(mergeData);
+            resolve(output);
         })
             .write(dataBuffer, (error) => {
-            if (error) {
-                reject(error);
-            }
+            error && reject(error);
             encoder.end();
         });
     });
 }
-exports.default = generate;
+exports.generate = generate;

package/lib/index.d.ts

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

package/lib/index.js

@@ -9,13 +9,11 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generate = exports.parse = void 0;
+exports.generate = exports.detect = exports.parse = void 0;
 var parse_1 = require("./parse");
-Object.defineProperty(exports, "parse", { enumerable: true, get: function () { return __importDefault(parse_1).default; } });
+Object.defineProperty(exports, "parse", { enumerable: true, get: function () { return parse_1.parse; } });
+Object.defineProperty(exports, "detect", { enumerable: true, get: function () { return parse_1.detect; } });
 var generate_1 = require("./generate");
-Object.defineProperty(exports, "generate", { enumerable: true, get: function () { return __importDefault(generate_1).default; } });
+Object.defineProperty(exports, "generate", { enumerable: true, get: function () { return generate_1.generate; } });
 __exportStar(require("./types"), exports);

package/lib/parse.d.ts

@@ -1,3 +1,27 @@
-import { Model } from "./types";
-declare function parse(qr: string): Promise<Model>;
-export default parse;
+/// <reference types="node" />
+import { Model } from ".";
+/**
+ * Generating by square Code
+ *
+ * @see {spec 3.14.}
+ */
+export declare function createModel(tabbedString: string): Model;
+/**
+ * Decoding client data from QR Code 2005 symbol
+ *
+ * @see {spec 3.16.}
+ */
+export declare function parse(qr: string): Promise<Model>;
+/**
+ * Reverse alphanumeric conversion using Base32hex
+ *
+ * @see {spec 3.13.}
+ */
+export declare function inverseAlphanumericConversion(qr: string): Buffer;
+/**
+ * Simple binary header detector
+ *
+ * The Bysquare header is pretty useless, so the detection isn't as reliable as
+ * I'd like
+ */
+export declare function detect(qr: string): boolean;

package/lib/parse.js

@@ -1,49 +1,137 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+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]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const lzma_native_1 = __importDefault(require("lzma-native"));
-const utils_1 = require("./utils");
-function parse(qr) {
-    const binary = [...qr].reduce((acc, char) => {
-        acc += utils_1.SUBST.indexOf(char).toString(2).padStart(5, "0");
+exports.detect = exports.inverseAlphanumericConversion = exports.parse = exports.createModel = void 0;
+const lzma = __importStar(require("lzma-native"));
+const _1 = require(".");
+const generate_1 = require("./generate");
+/**
+ * Generating by square Code
+ *
+ * @see {spec 3.14.}
+ */
+function createModel(tabbedString) {
+    const model = tabbedString
+        .split("\t")
+        .filter((ch) => !(ch === "\x00"))
+        .reduce((acc, value, i) => {
+        const key = _1.ModelOrdered[i];
+        if (value === "") {
+            return acc;
+        }
+        const numericKeys = [
+            "Payments",
+            "PaymentOptions",
+            "Amount",
+            "BankAccounts",
+            "StandingOrderExt",
+            "Day",
+            "Month",
+            "DirectDebitExt",
+            "DirectDebitScheme",
+            "DirectDebitType",
+            "MaxAmount"
+        ];
+        if (numericKeys.includes(key)) {
+            acc[key] = Number(value);
+            return acc;
+        }
+        acc[key] = value;
         return acc;
-    }, "");
-    let bytes = [];
-    for (let nth = 0, leftCount = 0; binary.length > leftCount; nth++) {
-        /** string representation of 8xbits */
-        const slice = binary.slice(leftCount, (leftCount += 8));
-        const byte = parseInt(slice, 2);
-        bytes[nth] = byte;
-    }
-    const input = Buffer.from(bytes);
-    // const header = inpEditorConfig.EditorConfigut.slice(0, 2)
-    // const size = input.slice(2, 4)
-    const data = input.slice(4);
+    }, {});
+    return model;
+}
+exports.createModel = createModel;
+/**
+ * Decoding client data from QR Code 2005 symbol
+ *
+ * @see {spec 3.16.}
+ */
+function parse(qr) {
+    const inversed = inverseAlphanumericConversion(qr);
+    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_native_1.default.createStream("rawDecoder", {
+    const decoder = lzma.createStream("rawDecoder", {
         synchronous: true,
         // @ts-ignore: Missing filter types
-        filters: [{ id: lzma_native_1.default.FILTER_LZMA1 }]
+        filters: [{ id: lzma.FILTER_LZMA1 }]
     });
     return new Promise((resolve, reject) => {
         decoder
             .on("error", reject)
             .on("data", (decompress) => {
-            const checksum = decompress.slice(0, 4);
+            const _crc32 = decompress.slice(0, 4);
             const data = decompress.slice(4).toString();
-            // TODO: Not neccesary to validate, but data can be corrupted
-            // if (!createChecksum(data).equals(checksum)) {
-            // 	reject("Checksum conflict")
-            // }
-            const model = (0, utils_1.createModel)(data);
+            const model = createModel(data);
             resolve(model);
         })
-            .write(data, (err) => {
-            err && reject(err);
+            .write(compressedData, (error) => {
+            error && reject(error);
             decoder.end();
         });
     });
 }
-exports.default = parse;
+exports.parse = parse;
+/**
+ * Reverse alphanumeric conversion using Base32hex
+ *
+ * @see {spec 3.13.}
+ */
+function inverseAlphanumericConversion(qr) {
+    const binary = [...qr].reduce((acc, char) => {
+        acc += generate_1.SUBST.indexOf(char).toString(2).padStart(5, "0");
+        return acc;
+    }, "");
+    let bytes = [];
+    for (let nth = 0, leftCount = 0; binary.length > leftCount; nth++) {
+        /** string representation of 8-bits */
+        const slice = binary.slice(leftCount, (leftCount += 8));
+        const byte = parseInt(slice, 2);
+        bytes[nth] = byte;
+    }
+    return Buffer.from(bytes);
+}
+exports.inverseAlphanumericConversion = inverseAlphanumericConversion;
+/**
+ * Simple binary header detector
+ *
+ * The Bysquare header is pretty useless, so the detection isn't as reliable as
+ * I'd like
+ */
+function detect(qr) {
+    const inversed = inverseAlphanumericConversion(qr);
+    if (inversed.byteLength < 2) {
+        return false;
+    }
+    const headerBysquare = inversed.slice(0, 2);
+    return [...headerBysquare.toString("hex")]
+        .map((nibble) => parseInt(nibble, 16))
+        .every((nibble, index) => {
+        // check version, actual v1.x.x
+        if (index === 1) {
+            return nibble <= 2;
+        }
+        return 0 <= nibble && nibble <= 15;
+    });
+}
+exports.detect = detect;

package/lib/types.d.ts

@@ -1,6 +1,5 @@
 /**
  * Table 15. PAY by square sequence data model (page 30.)
- * @see{./docs/specification_v1.1.0.pdf}
  */
 export interface Model {
     /**
@@ -12,8 +11,6 @@ export interface Model {
      */
     Payments: number;
     /**
-     * Needs to be filled in with “paymentorder” option
-     *
      * Max length 1
      */
     PaymentOptions: number;
@@ -72,8 +69,9 @@ export interface Model {
      */
     IBAN: string;
     /**
-     * Max length 11
      * Format ISO 9362, 8 or 11 characters long
+     *
+     * Max length 11
      */
     BIC?: string;
     /**

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.1",
+	"version": "1.2.2",
 	"license": "Apache-2.0",
 	"author": "Filip Seman <filip.seman@protonmail.com>",
 	"keywords": [
@@ -21,6 +21,7 @@
 	"homepage": "https://github.com/xseman/bysquare#readme",
 	"funding": "https://github.com/sponsors/xseman",
 	"scripts": {
+		"prebuild": "rm -rf ./lib || :",
 		"build": "tsc && chmod +x ./lib/cli.js",
 		"test": "vitest",
 		"test:watch": "vitest --watch",
@@ -28,7 +29,7 @@
 		"format": "npx prettier --write ./*/**.ts --ignore-path ./.gitignore",
 		"version": "git flow release start v$npm_package_version",
 		"prepare": "",
-		"prepublishOnly": "rm -rf ./lib && npm run build",
+		"prepublishOnly": "npm run build",
 		"preversion": "git checkout develop",
 		"postversion": ""
 	},

package/lib/utils.d.ts

@@ -1,32 +0,0 @@
-/// <reference types="node" />
-import { Model } from "./types";
-/**
- * spec 3.13 (Table 9 – Encoding table)
- */
-declare const SUBST = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
-/**
- * ```
- * | Attribute    | Number of bits | Possible values | Note
- * --------------------------------------------------------------------------------------------
- * | BySquareType | 4              | 0-15            | by square type
- * | Version      | 4              | 0-15            | version 4 0­15 version of the by sq
- * | DocumentType | 4              | 0-15            | document type within given by square type
- * | Reserved     | 4              | 0-15            | bits reserved for future needs
- * ```
- */
-declare function createHeader(header?: [
-    BySquareType: number,
-    Version: number,
-    DocumentType: number,
-    Reserved: number
-]): Buffer;
-declare function createChecksum(tabbedInput: string): Buffer;
-declare function dataWithChecksum(model: Model): Buffer;
-/**
- * Order keys by specification
- * Fill empty values
- * Transform to tabbed string
- */
-declare function createTabbedString(model: Model): string;
-declare function createModel(tabbedString: string): Model;
-export { createChecksum, createHeader, createModel, createTabbedString, dataWithChecksum, SUBST };

package/lib/utils.js

@@ -1,106 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SUBST = exports.dataWithChecksum = exports.createTabbedString = exports.createModel = exports.createHeader = exports.createChecksum = void 0;
-const lzma_native_1 = __importDefault(require("lzma-native"));
-const types_1 = require("./types");
-/**
- * spec 3.13 (Table 9 – Encoding table)
- */
-const SUBST = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
-exports.SUBST = SUBST;
-/**
- * ```
- * | Attribute    | Number of bits | Possible values | Note
- * --------------------------------------------------------------------------------------------
- * | BySquareType | 4              | 0-15            | by square type
- * | Version      | 4              | 0-15            | version 4 0­15 version of the by sq
- * | DocumentType | 4              | 0-15            | document type within given by square type
- * | Reserved     | 4              | 0-15            | bits reserved for future needs
- * ```
- */
-function createHeader(
-// prettier-ignore
-header = [
-    0b0000_0000, 0b0000_0000,
-    0b0000_0000, 0b0000_0000
-]) {
-    const isValid = header.every((nibble) => 0 <= nibble && nibble <= 15);
-    if (!isValid)
-        throw new Error();
-    const [BySquareType, Version, DocumentType, Reserved] = header;
-    /** Combine 4-nibbles to 2-bytes */
-    const headerBuffer = Buffer.from([
-        (BySquareType << 4) | (Version << 0),
-        (DocumentType << 4) | (Reserved << 0)
-    ]);
-    return headerBuffer;
-}
-exports.createHeader = createHeader;
-function createChecksum(tabbedInput) {
-    // @ts-ignore: Wrong return type
-    const data = lzma_native_1.default.crc32(tabbedInput);
-    const crc32 = Buffer.alloc(4);
-    crc32.writeUInt32LE(data);
-    return crc32;
-}
-exports.createChecksum = createChecksum;
-function dataWithChecksum(model) {
-    const tabbedString = createTabbedString(model);
-    const checksum = createChecksum(tabbedString);
-    const merged = Buffer.concat([
-        checksum,
-        Buffer.from(tabbedString, "utf-8")
-    ]);
-    return merged;
-}
-exports.dataWithChecksum = dataWithChecksum;
-/**
- * Order keys by specification
- * Fill empty values
- * Transform to tabbed string
- */
-function createTabbedString(model) {
-    const tabbedModel = Object.keys(model)
-        .reduce((acc, key) => {
-        acc[types_1.ModelOrdered[key]] = String(model[key] ?? "");
-        return acc;
-    }, Array(33).fill(""))
-        .join("\t");
-    return tabbedModel;
-}
-exports.createTabbedString = createTabbedString;
-function createModel(tabbedString) {
-    const model = tabbedString
-        .split("\t")
-        .filter((ch) => !(ch === "\x00"))
-        .reduce((acc, value, i) => {
-        const key = types_1.ModelOrdered[i];
-        if (value === "") {
-            return acc;
-        }
-        const numericKeys = [
-            "Payments",
-            "PaymentOptions",
-            "Amount",
-            "BankAccounts",
-            "StandingOrderExt",
-            "Day",
-            "Month",
-            "DirectDebitExt",
-            "DirectDebitScheme",
-            "DirectDebitType",
-            "MaxAmount"
-        ];
-        if (numericKeys.includes(key)) {
-            acc[key] = Number(value);
-            return acc;
-        }
-        acc[key] = value;
-        return acc;
-    }, {});
-    return model;
-}
-exports.createModel = createModel;