@qrkit/bc-ur 2.0.0-beta.9-qrkit.1

package/dist/commonjs/classes/UR.js

@@ -0,0 +1,243 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UR = void 0;
+const RegistryItem_js_1 = require("./RegistryItem.js");
+const EncodingMethodName_js_1 = require("../enums/EncodingMethodName.js");
+const errors_js_1 = require("../errors.js");
+const index_js_1 = require("../encodingMethods/index.js");
+/**
+ * https://github.com/BlockchainCommons/Research/blob/master/papers/bcr-2020-005-ur.md
+ * Class that represents the structure of the data we encode/decode in this package.
+ * e.g. 'ur:bytes/lpamcmcfatrdcyzcpldpgwhdhtiaiaecgyktgsflguhshthfghjtjngrhsfegtiafegaktgugui'
+ *
+ *
+ * Single part = ur:<type>/<message(payload)>
+ * Multi part =  ur:<type>/<seqNum-seqLength>/<fragment(payload)>
+ *
+ * CBOR encoding should not include tag on top level when UR has a tag
+ *
+ * I want to be able to create UR from encoding normal js types
+ * Or from any type in the pipeline
+ *
+ * Should i do it on the encoder or ur class itself?
+ */
+class UR {
+    type;
+    payload;
+    seqNum;
+    seqLength;
+    isFragment;
+    static pipeline = index_js_1.dataPipeline;
+    // If type is unknown it should be cbor, because default encoding will take any and convert to cbor without tagging
+    constructor(input) {
+        // Create from registry item
+        if (input instanceof RegistryItem_js_1.RegistryItemBase || (0, RegistryItem_js_1.isRegistryItem)(input)) {
+            const ur = UR.fromRegistryItem(input);
+            this.type = ur.type;
+            this.payload = ur.payload;
+            this.seqNum = ur.seqNum;
+            this.seqLength = ur.seqLength;
+            this.isFragment = ur.isFragment;
+        }
+        // Create from raw data
+        else if (typeof input == "object" && 'type' in input && 'payload' in input) {
+            const { type, payload, seqNum = 0, seqLength = 0 } = input;
+            this.payload = payload;
+            this.type = type;
+            this.seqNum = seqNum;
+            this.seqLength = seqLength;
+            this.isFragment = seqLength > 0;
+        }
+        else {
+            throw new errors_js_1.InvalidTypeError();
+        }
+    }
+    // Decode
+    decode(until) {
+        return UR.pipeline.decode(this.payload, { until, enforceType: this.isFragment ? undefined : this.type });
+    }
+    // Get string representation
+    toString() {
+        return UR.getUrString(this.type, this.payload, this.seqNum, this.seqLength);
+    }
+    // Get payload in bytewords
+    getPayloadBytewords() {
+        return this.payload;
+    }
+    // Get payload in hex
+    getPayloadHex() {
+        return UR.pipeline.decode(this.payload, { until: EncodingMethodName_js_1.EncodingMethodName.hex });
+        // TODO: add tag information
+    }
+    // Get Payload in cbor
+    getPayloadCbor() {
+        return UR.pipeline.decode(this.payload, { until: EncodingMethodName_js_1.EncodingMethodName.cbor });
+        // TODO: add tag information
+    }
+    toRegistryItem() {
+        if (this.isFragment) {
+            throw new Error("Cannot convert a multipart ur to registry item, it needs to be decoded first");
+        }
+        // Enforce type
+        // registrtqueryByURType
+        return UR.decode(this);
+    }
+    /// Static methods
+    static fromRegistryItem(item) {
+        // First convert Registry item to bytewords
+        // Only on the top level, we should not include the tag
+        const bytewords = UR.pipeline.encode(item, { ignoreTopLevelTag: true });
+        // Now create new UR
+        return new UR({
+            type: item.type.URType,
+            payload: bytewords,
+        });
+    }
+    /**
+     * Create UR from native javascript types by encoding them to bytewords
+     * @param input
+     * @returns
+     */
+    static fromData(input) {
+        const bytewords = UR.pipeline.encode(input.payload);
+        // Now create new UR
+        return new UR({
+            ...input,
+            payload: bytewords,
+        });
+    }
+    static fromCbor(input) {
+        // This means we already have cbor Uint8Array
+        // So we will start from the next method
+        const bytewords = UR.pipeline.encode(input.payload, { from: EncodingMethodName_js_1.EncodingMethodName.hex });
+        return new UR({
+            ...input,
+            payload: bytewords,
+        });
+    }
+    static fromHex(input) {
+        // This means we already have hex string
+        // So we will start from the next method
+        const bytewords = UR.pipeline.encode(input.payload, { from: EncodingMethodName_js_1.EncodingMethodName.bytewords });
+        return new UR({
+            ...input,
+            payload: bytewords,
+        });
+    }
+    static fromBytewords(input) {
+        return new UR({
+            ...input,
+        });
+    }
+    static from(input, type) {
+        switch (type) {
+            case EncodingMethodName_js_1.EncodingMethodName.bytewords:
+                return UR.fromBytewords(input);
+            case EncodingMethodName_js_1.EncodingMethodName.cbor:
+                return UR.fromCbor(input);
+            case EncodingMethodName_js_1.EncodingMethodName.hex:
+                return UR.fromHex(input);
+            case EncodingMethodName_js_1.EncodingMethodName.ur:
+                return UR.fromData(input);
+            default:
+                throw new Error("Invalid encoding method");
+        }
+    }
+    static fromString(ur) {
+        return new UR(UR.parseUr(ur));
+    }
+    static encode = this.fromRegistryItem;
+    static decode(ur) {
+        // Force cbor type
+        return UR.pipeline.decode(ur.payload);
+    }
+    /**
+     * Check if the given string is a valid UR
+     * For single part ur, it should be in the form of "ur:<type>/<payload>" which is "ur:<lowercase letters, numbers or dashes>/<bytewords>"
+     * For multi part ur, it should be in the form of "ur:<type>/<seqNum-seqLength>/<fragment>" which is "ur:<lowercase letters, numbers or dashes>/<number-number>/<bytewords>"
+     * ur uses minimal bytewords encoding style which is a-z and has checksome bytes at the end
+     *
+     * @param input
+     * @returns
+     */
+    static validate(input) {
+        // TODO: use bytewords encoding to validate the payload
+        const singlePartPattern = /^ur:[a-z0-9-]+\/[a-z]+$/;
+        const multiPartPattern = /^ur:[a-z0-9-]+\/[0-9]+-[0-9]+\/[a-z]+$/;
+        return singlePartPattern.test(input) || multiPartPattern.test(input);
+    }
+    /**
+     * Generates a UR string from the given type and payload.
+     * Single part = ur:<type>/<message(payload)> if seqNum and seqLength are 0
+     * Multi part =  ur:<type>/<seqNum-seqLength>/<fragment(payload)>
+     */
+    static getUrString(type, payload, seqNum = 0, seqLen = 0) {
+        // Single UR
+        if (seqNum === 0 && seqLen === 0) {
+            return joinUri("ur", [type, payload]);
+        }
+        // Multi part UR
+        const seq = `${seqNum}-${seqLen}`;
+        return joinUri("ur", [type, seq, payload]);
+    }
+    /**
+     * Parses a UR and performs basic validation
+     * @param message e.g. "UR:BYTES/6-23/LPAMCHCFATTTCYCLEHGSDPHDHGEHFGHKKKDL..."
+     */
+    static parseUr(message) {
+        const lowercase = message.toLowerCase(); // e.g. "ur:bytes/6-23/lpamchcfatttcyclehgsdphdhgehfghkkkdl..."
+        // check if it is valid ur string
+        if (!UR.validate(lowercase)) {
+            throw new Error("Invalid UR string");
+        }
+        const components = lowercase.slice(3).split("/");
+        let isFragment = false;
+        let seqNum = 0;
+        let seqLength = 0;
+        let payload = "";
+        // Check for the number of components
+        switch (components.length) {
+            case 2:
+                // single part ur
+                isFragment = false;
+                break;
+            case 3:
+                // multi part ur
+                isFragment = true;
+                break;
+            default:
+                throw new errors_js_1.InvalidPathLengthError();
+        }
+        const type = components[0]; //e.g. "bytes"
+        if (isFragment) {
+            const seq = components[1]; //e.g. "6-23"
+            const [num, length] = seq.split("-").map(Number);
+            seqNum = num;
+            seqLength = length;
+            payload = components[2];
+        }
+        else {
+            payload = components[1];
+        }
+        return {
+            type,
+            payload,
+            seqNum,
+            seqLength,
+            isFragment,
+        };
+    }
+}
+exports.UR = UR;
+/// Helper functions
+/**
+ * Generates a uri. e.g. 'ur:bytes/6-22/lpamcmcfatrdcyzcpldpgwhdhtiaiaecgyktgsflguhshthfghjtjngrhsfegtiafegaktgugui'
+ * @param scheme scheme of the uri. e.g. "ur"
+ * @param pathComponents adds additional information to the uri in the form of a path (divided by "/"). e.g. "bytes/6-22/lpamcmcfatrdcyzcpldpgwhdhtiaiaecgyktgsflguhshthfghjtjngrhsfegtiafegaktgugui"
+ * @returns the complete uri.
+ */
+function joinUri(scheme, pathComponents) {
+    const path = pathComponents.join("/");
+    return [scheme, path].join(":");
+}
+//# sourceMappingURL=UR.js.map

package/dist/commonjs/classes/UR.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UR.js","sourceRoot":"","sources":["../../../src/classes/UR.ts"],"names":[],"mappings":";;;AAAA,uDAAmF;AACnF,0EAAoE;AAEpE,4CAIsB;AACtB,0DAA2D;AAW3D;;;;;;;;;;;;;;;GAeG;AACH,MAAa,EAAE;IACN,IAAI,CAAS;IACb,OAAO,CAAS;IAChB,MAAM,CAAU;IAChB,SAAS,CAAU;IACnB,UAAU,CAAU;IAE3B,MAAM,CAAC,QAAQ,GAAkC,uBAAY,CAAC;IAE9D,mHAAmH;IACnH,YAAY,KAAyB;QACnC,4BAA4B;QAC5B,IAAI,KAAK,YAAY,kCAAgB,IAAI,IAAA,gCAAc,EAAC,KAAK,CAAC,EAAE,CAAC;YAC/D,MAAM,EAAE,GAAG,EAAE,CAAC,gBAAgB,CAAC,KAAqB,CAAC,CAAC;YACtD,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC,IAAI,CAAC;YACpB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC;YAC1B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,MAAM,CAAC;YACxB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC,SAAS,CAAC;YAC9B,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC,UAAU,CAAC;QAClC,CAAC;QACD,uBAAuB;aAClB,IAAI,OAAO,KAAK,IAAI,QAAQ,IAAI,MAAM,IAAI,KAAK,IAAI,SAAS,IAAI,KAAK,EAAE,CAAC;YAC3E,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,GAAG,CAAC,EAAE,SAAS,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC;YAC3D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;YAC3B,IAAI,CAAC,UAAU,GAAG,SAAS,GAAG,CAAC,CAAC;QAClC,CAAC;aACI,CAAC;YACJ,MAAM,IAAI,4BAAgB,EAAE,CAAC;QAC/B,CAAC;IACH,CAAC;IAED,SAAS;IACT,MAAM,CAAC,KAA0B;QAC/B,OAAO,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,EAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAC,CAAC,CAAC;IACzG,CAAC;IAED,4BAA4B;IAC5B,QAAQ;QACN,OAAO,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9E,CAAC;IAED,2BAA2B;IAC3B,mBAAmB;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,qBAAqB;IACrB,aAAa;QACX,OAAO,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAS,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,0CAAkB,CAAC,GAAG,EAAE,CAAC,CAAC;QACnF,4BAA4B;IAC9B,CAAC;IAED,sBAAsB;IACtB,cAAc;QACZ,OAAO,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAa,IAAI,CAAC,OAAO,EAAE,EAAC,KAAK,EAAE,0CAAkB,CAAC,IAAI,EAAC,CAAE,CAAC;QACvF,4BAA4B;IAC9B,CAAC;IAED,cAAc;QACZ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CACb,8EAA8E,CAC/E,CAAC;QACJ,CAAC;QACD,eAAe;QACf,wBAAwB;QACxB,OAAO,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED,kBAAkB;IAElB,MAAM,CAAC,gBAAgB,CAAC,IAAkB;QACxC,2CAA2C;QAC3C,uDAAuD;QACvD,MAAM,SAAS,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,EAAC,iBAAiB,EAAE,IAAI,EAAC,CAAC,CAAC;QAEtE,oBAAoB;QACpB,OAAO,IAAI,EAAE,CAAC;YACZ,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;YACtB,OAAO,EAAE,SAAS;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,KAA0C;QACxD,MAAM,SAAS,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEpD,oBAAoB;QACpB,OAAO,IAAI,EAAE,CAAC;YACZ,GAAG,KAAK;YACR,OAAO,EAAE,SAAS;SACnB,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,KAAiD;QAC/D,6CAA6C;QAC7C,wCAAwC;QACxC,MAAM,SAAS,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,0CAAkB,CAAC,GAAG,EAAE,CAAC,CAAC;QAEtF,OAAO,IAAI,EAAE,CAAC;YACZ,GAAG,KAAK;YACR,OAAO,EAAE,SAAS;SACnB,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,KAA6C;QAC1D,wCAAwC;QACxC,wCAAwC;QACxC,MAAM,SAAS,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,0CAAkB,CAAC,SAAS,EAAE,CAAC,CAAC;QAE5F,OAAO,IAAI,EAAE,CAAC;YACZ,GAAG,KAAK;YACR,OAAO,EAAE,SAAS;SACnB,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,KAAU;QAC7B,OAAO,IAAI,EAAE,CAAC;YACZ,GAAG,KAAK;SACT,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,KAA0C,EAAE,IAAwB;QAC9E,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,0CAAkB,CAAC,SAAS;gBAC/B,OAAO,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACjC,KAAK,0CAAkB,CAAC,IAAI;gBAC1B,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC5B,KAAK,0CAAkB,CAAC,GAAG;gBACzB,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC3B,KAAK,0CAAkB,CAAC,EAAE;gBACxB,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC5B;gBACE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,EAAU;QAC1B,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC;IACtC,MAAM,CAAC,MAAM,CAAC,EAAM;QAClB,kBAAkB;QAClB,OAAO,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAa;QAC3B,uDAAuD;QAEvD,MAAM,iBAAiB,GAAG,yBAAyB,CAAC;QACpD,MAAM,gBAAgB,GAAG,wCAAwC,CAAC;QAElE,OAAO,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAChB,IAAY,EACZ,OAAe,EACf,MAAM,GAAG,CAAC,EACV,MAAM,GAAG,CAAC;QAEV,YAAY;QACZ,IAAI,MAAM,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QACxC,CAAC;QAED,gBAAgB;QAChB,MAAM,GAAG,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;QAClC,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAAO,CAAC,OAAe;QAC5B,MAAM,SAAS,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,+DAA+D;QAExG,iCAAiC;QACjC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvC,CAAC;QAED,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,IAAI,OAAO,GAAG,EAAE,CAAC;QAEjB,qCAAqC;QACrC,QAAQ,UAAU,CAAC,MAAM,EAAE,CAAC;YAC1B,KAAK,CAAC;gBACJ,iBAAiB;gBACjB,UAAU,GAAG,KAAK,CAAC;gBACnB,MAAM;YACR,KAAK,CAAC;gBACJ,gBAAgB;gBAChB,UAAU,GAAG,IAAI,CAAC;gBAClB,MAAM;YACR;gBACE,MAAM,IAAI,kCAAsB,EAAE,CAAC;QACvC,CAAC;QAED,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc;QAC1C,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,GAAG,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa;YACxC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACjD,MAAM,GAAG,GAAG,CAAC;YACb,SAAS,GAAG,MAAM,CAAC;YACnB,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAC1B,CAAC;QAED,OAAO;YACL,IAAI;YACJ,OAAO;YACP,MAAM;YACN,SAAS;YACT,UAAU;SACX,CAAC;IACJ,CAAC;;AAnPH,gBAoPC;AAED,oBAAoB;AAEpB;;;;;GAKG;AACH,SAAS,OAAO,CAAC,MAAc,EAAE,cAAwB;IACvD,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClC,CAAC"}

package/dist/commonjs/classes/UrFountainDecoder.d.ts

@@ -0,0 +1,15 @@
+import { RegistryItem } from "../classes/RegistryItem.js";
+import { FountainDecoder, MultipartPayload } from "./FountainDecoder.js";
+import { UR } from "./UR.js";
+export declare class UrFountainDecoder extends FountainDecoder {
+    expectedType: string;
+    resultUr: UR;
+    decodedData: RegistryItem | any;
+    constructor(parts?: UR[] | string[]);
+    reset(): void;
+    setExpectedValuesUr(part: UR, decodedPart: MultipartPayload): void;
+    protected validateUr(part: UR, decodedPart: MultipartPayload): boolean;
+    receivePartUr(part: UR | string): boolean;
+    finalize(): void;
+    getDecodedData(): RegistryItem | any;
+}

package/dist/commonjs/classes/UrFountainDecoder.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UrFountainDecoder = void 0;
+const EncodingMethodName_js_1 = require("../enums/EncodingMethodName.js");
+const FountainDecoder_js_1 = require("./FountainDecoder.js");
+const UR_js_1 = require("./UR.js");
+class UrFountainDecoder extends FountainDecoder_js_1.FountainDecoder {
+    expectedType;
+    resultUr;
+    decodedData;
+    constructor(parts = []) {
+        super();
+        parts.forEach((part) => {
+            this.receivePartUr(part);
+        });
+    }
+    reset() {
+        super.reset();
+        this.resultUr = undefined;
+        this.expectedType = undefined;
+    }
+    setExpectedValuesUr(part, decodedPart) {
+        this.expectedType = part.type;
+        this.expectedPartCount = part.seqLength;
+        super.setExpectedValues(decodedPart);
+    }
+    validateUr(part, decodedPart) {
+        // Check if UR is a fragment
+        if (!part.isFragment) {
+            return false;
+        }
+        // Check the type of the UR
+        if (part.type !== this.expectedType) {
+            return false;
+        }
+        // Expect metadata ur seqNum to be equal to the decoded part seqNum
+        if (part.seqNum !== decodedPart.seqNum) {
+            return false;
+        }
+        // Expect metadata ur seqLength to be equal to the decoded part seqLength
+        if (part.seqLength !== decodedPart.seqLength) {
+            return false;
+        }
+        // Validate decoded paylad
+        return super.validatePart(decodedPart);
+    }
+    receivePartUr(part) {
+        // If we already have a result, we're done
+        if (this.done) {
+            return false;
+        }
+        // Convert string into UR
+        if (typeof part === "string") {
+            part = UR_js_1.UR.fromString(part);
+        }
+        // If what we received is not a multupart UR, then we're done
+        if (!part.isFragment) {
+            // If this is not a fragment and we have not received any fragments yet then its the whole UR
+            if (!this.started) {
+                this.resultUr = part;
+                this.started = true;
+                this.done = true;
+                try {
+                    this.decodedData = this.resultUr.decode();
+                }
+                catch (error) {
+                    this.error = error;
+                }
+                // Finish here
+                return true;
+            }
+            // If we have received fragments before then this is an error
+            else {
+                return false;
+            }
+        }
+        let parsed;
+        try {
+            const decoded = part.decode();
+            parsed = (0, FountainDecoder_js_1.validateDecodedMultipart)(decoded);
+        }
+        catch (e) {
+            console.error(e);
+            return false;
+        }
+        // If this is the first part we've seen then set expected values
+        if (!this.started)
+            this.setExpectedValuesUr(part, parsed);
+        // If this is a fragment validate UR
+        if (!this.validateUr(part, parsed)) {
+            return false;
+        }
+        return super.receivePart(parsed);
+    }
+    // Assemble data and generate single result UR
+    finalize() {
+        super.finalize();
+        if (this.error) {
+            return;
+        }
+        if (this.resultRaw !== undefined) {
+            // Result data is already in CBOR
+            // Just convert it to bytewords instead of encoding it again
+            const payload = UR_js_1.UR.pipeline.encode(this.resultRaw, { from: EncodingMethodName_js_1.EncodingMethodName.hex });
+            this.resultUr = new UR_js_1.UR({
+                type: this.expectedType,
+                payload: payload,
+            });
+            // Now Try to decode the result UR
+            try {
+                this.decodedData = this.resultUr.decode();
+            }
+            catch (error) {
+                this.error = error;
+            }
+        }
+    }
+    getDecodedData() {
+        if (!this.isSuccessful()) {
+            console.log("Fountain decoding was not successful");
+            return undefined;
+        }
+        return this.decodedData;
+    }
+}
+exports.UrFountainDecoder = UrFountainDecoder;
+//# sourceMappingURL=UrFountainDecoder.js.map

package/dist/commonjs/classes/UrFountainDecoder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UrFountainDecoder.js","sourceRoot":"","sources":["../../../src/classes/UrFountainDecoder.ts"],"names":[],"mappings":";;;AACA,0EAAoE;AACpE,6DAAmG;AACnG,mCAA6B;AAE7B,MAAa,iBAAkB,SAAQ,oCAAe;IAC7C,YAAY,CAAS;IACrB,QAAQ,CAAK;IACb,WAAW,CAAqB;IAEvC,YAAY,QAAyB,EAAE;QACrC,KAAK,EAAE,CAAC;QACR,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK;QACV,KAAK,CAAC,KAAK,EAAE,CAAC;QACd,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;IAChC,CAAC;IAED,mBAAmB,CAAC,IAAQ,EAAE,WAA6B;QACzD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC;QAC9B,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC;QACxC,KAAK,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC;IAES,UAAU,CAAC,IAAQ,EAAE,WAA6B;QAC1D,4BAA4B;QAC5B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,2BAA2B;QAC3B,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,YAAY,EAAE,CAAC;YACpC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,mEAAmE;QACnE,IAAI,IAAI,CAAC,MAAM,KAAK,WAAW,CAAC,MAAM,EAAE,CAAC;YACvC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,yEAAyE;QACzE,IAAI,IAAI,CAAC,SAAS,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC;YAC7C,OAAO,KAAK,CAAC;QACf,CAAC;QAED,0BAA0B;QAC1B,OAAO,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IACzC,CAAC;IAED,aAAa,CAAC,IAAiB;QAC7B,0CAA0C;QAC1C,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;QACf,CAAC;QAED,yBAAyB;QACzB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,GAAG,UAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QAED,6DAA6D;QAC7D,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,6FAA6F;YAC7F,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBAClB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACrB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;gBACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;gBAEjB,IAAI,CAAC;oBACH,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBAC5C,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;gBACrB,CAAC;gBAED,cAAc;gBACd,OAAO,IAAI,CAAC;YACd,CAAC;YACD,6DAA6D;iBACxD,CAAC;gBACJ,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,IAAI,MAAwB,CAAC;QAC7B,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAC9B,MAAM,GAAG,IAAA,6CAAwB,EAAC,OAAO,CAAC,CAAC;QAC7C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,gEAAgE;QAChE,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAE1D,oCAAoC;QACpC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;YACnC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED,8CAA8C;IACvC,QAAQ;QACb,KAAK,CAAC,QAAQ,EAAE,CAAC;QAEjB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACjC,iCAAiC;YACjC,4DAA4D;YAC5D,MAAM,OAAO,GAAG,UAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,0CAAkB,CAAC,GAAG,EAAE,CAAC,CAAC;YACrF,IAAI,CAAC,QAAQ,GAAG,IAAI,UAAE,CAAC;gBACrB,IAAI,EAAE,IAAI,CAAC,YAAY;gBACvB,OAAO,EAAE,OAAO;aACjB,CAAC,CAAC;YAEH,kCAAkC;YAClC,IAAI,CAAC;gBACH,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC5C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;YACzB,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;YACpD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;CACF;AAxID,8CAwIC"}

package/dist/commonjs/classes/UrFountainEncoder.d.ts

@@ -0,0 +1,42 @@
+import { RegistryItem } from "../classes/RegistryItem.js";
+import { UR } from "./UR.js";
+import { FountainEncoder } from "./FountainEncoder.js";
+/**
+ * UrFountainEncoder encodes data on the fly using an internal state to keep generating UR fragments of the payload.
+ * It extends the FountainEncoder class to provide additional functionality specific to UR encoding.
+ */
+export declare class UrFountainEncoder extends FountainEncoder {
+    /** The UR type of the input data */
+    private _type;
+    /** The original input data as a UR object */
+    private _inputUr;
+    /** Reset counter to 1 after hitting `fragmentCount * ratio`; if undefined or 0, it goes forever */
+    repeatAfterRatio: number;
+    /**
+     * Creates an instance of UrFountainEncoder.
+     * @param input - The input data to be encoded, either as a RegistryItem or UR.
+     * @param maxFragmentLength - The maximum length of each fragment.
+     * @param minFragmentLength - The minimum length of each fragment.
+     * @param firstSeqNum - The sequence number to start with.
+     * @param repeatAfterRatio - The ratio after which the sequence number resets. Default is 2. If 0 fountain goes forever.
+     */
+    constructor(input: RegistryItem | UR, maxFragmentLength?: number, minFragmentLength?: number, firstSeqNum?: number, repeatAfterRatio?: number);
+    /**
+     * Return all the fragments based on the fountain ratio at once as an array of Uint8Arrays.
+     * @param fountainRatio - The ratio of the fountain fragments to the pure fragments. Default is 0.
+     * @returns An array of UR objects representing the fragments.
+     */
+    getAllPartsUr(fountainRatio?: number): UR[];
+    /**
+     * Give the 'next' fragment for the ur for which the fountainEncoder was created.
+     * @returns The 'next' fragment, represented as a Ur multipart string.
+     */
+    nextPartUr(): UR;
+    /**
+     * Converts a fragment to a UR object.
+     * @param seqNum - The sequence number of the fragment.
+     * @param fragment - The fragment data as a Uint8Array.
+     * @returns A UR object representing the fragment.
+     */
+    private fragment2Ur;
+}

package/dist/commonjs/classes/UrFountainEncoder.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UrFountainEncoder = void 0;
+const RegistryItem_js_1 = require("../classes/RegistryItem.js");
+const UR_js_1 = require("./UR.js");
+const FountainEncoder_js_1 = require("./FountainEncoder.js");
+const EncodingMethodName_js_1 = require("../enums/EncodingMethodName.js");
+/**
+ * UrFountainEncoder encodes data on the fly using an internal state to keep generating UR fragments of the payload.
+ * It extends the FountainEncoder class to provide additional functionality specific to UR encoding.
+ */
+class UrFountainEncoder extends FountainEncoder_js_1.FountainEncoder {
+    /** The UR type of the input data */
+    _type;
+    /** The original input data as a UR object */
+    _inputUr;
+    /** Reset counter to 1 after hitting `fragmentCount * ratio`; if undefined or 0, it goes forever */
+    repeatAfterRatio = 2;
+    /**
+     * Creates an instance of UrFountainEncoder.
+     * @param input - The input data to be encoded, either as a RegistryItem or UR.
+     * @param maxFragmentLength - The maximum length of each fragment.
+     * @param minFragmentLength - The minimum length of each fragment.
+     * @param firstSeqNum - The sequence number to start with.
+     * @param repeatAfterRatio - The ratio after which the sequence number resets. Default is 2. If 0 fountain goes forever.
+     */
+    constructor(input, maxFragmentLength = 100, minFragmentLength = 10, firstSeqNum = 0, repeatAfterRatio = 2) {
+        let inputUr;
+        // If the input is a RegistryItem, convert it to a Ur
+        if (input instanceof RegistryItem_js_1.RegistryItemBase || (0, RegistryItem_js_1.isRegistryItem)(input)) {
+            inputUr = UR_js_1.UR.fromRegistryItem(input);
+        }
+        else {
+            inputUr = input;
+        }
+        // Input in CBOR
+        let inputCBOR = inputUr.getPayloadCbor();
+        super(inputCBOR, maxFragmentLength, minFragmentLength, firstSeqNum);
+        this._inputUr = inputUr;
+        this._type = inputUr.type;
+        this.repeatAfterRatio = repeatAfterRatio;
+    }
+    /**
+     * Return all the fragments based on the fountain ratio at once as an array of Uint8Arrays.
+     * @param fountainRatio - The ratio of the fountain fragments to the pure fragments. Default is 0.
+     * @returns An array of UR objects representing the fragments.
+     */
+    getAllPartsUr(fountainRatio = 0) {
+        const allParts = super.getAllParts(fountainRatio);
+        return allParts.map((part, index) => this.fragment2Ur(index + 1, part));
+    }
+    /**
+     * Give the 'next' fragment for the ur for which the fountainEncoder was created.
+     * @returns The 'next' fragment, represented as a Ur multipart string.
+     */
+    nextPartUr() {
+        // Reset the sequence number if we hit the ratio
+        if (this.repeatAfterRatio) {
+            if (this._seqNum > this._pureFragments.length * this.repeatAfterRatio) {
+                this._seqNum = 0;
+            }
+        }
+        const encodedFragment = super.nextPart();
+        return this.fragment2Ur(this._seqNum, encodedFragment);
+    }
+    /**
+     * Converts a fragment to a UR object.
+     * @param seqNum - The sequence number of the fragment.
+     * @param fragment - The fragment data as a Uint8Array.
+     * @returns A UR object representing the fragment.
+     */
+    fragment2Ur(seqNum, fragment) {
+        // Fragment is already encoded in CBOR
+        // Just convert it to bytewords instead of encoding it again
+        const payload = UR_js_1.UR.pipeline.encode(fragment, { from: EncodingMethodName_js_1.EncodingMethodName.hex });
+        if (this.isSinglePart()) {
+            return new UR_js_1.UR({
+                type: this._type,
+                payload: payload,
+            });
+        }
+        return new UR_js_1.UR({
+            type: this._type,
+            payload: payload,
+            seqNum: seqNum,
+            seqLength: this._pureFragments.length,
+            isFragment: true,
+        });
+    }
+}
+exports.UrFountainEncoder = UrFountainEncoder;
+//# sourceMappingURL=UrFountainEncoder.js.map

package/dist/commonjs/classes/UrFountainEncoder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UrFountainEncoder.js","sourceRoot":"","sources":["../../../src/classes/UrFountainEncoder.ts"],"names":[],"mappings":";;;AAAA,gEAA4F;AAC5F,mCAA6B;AAC7B,6DAAuD;AACvD,0EAAoE;AAEpE;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,oCAAe;IACpD,oCAAoC;IAC5B,KAAK,CAAS;IACtB,6CAA6C;IACrC,QAAQ,CAAK;IACrB,mGAAmG;IAC5F,gBAAgB,GAAG,CAAC,CAAC;IAE5B;;;;;;;OAOG;IACH,YACE,KAAwB,EACxB,oBAA4B,GAAG,EAC/B,oBAA4B,EAAE,EAC9B,cAAsB,CAAC,EACvB,gBAAgB,GAAG,CAAC;QAGpB,IAAI,OAAO,CAAC;QACZ,qDAAqD;QACrD,IAAI,KAAK,YAAY,kCAAgB,IAAI,IAAA,gCAAc,EAAC,KAAK,CAAC,EAAE,CAAC;YAC/D,OAAO,GAAG,UAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACvC,CAAC;aACI,CAAC;YACJ,OAAO,GAAG,KAAK,CAAC;QAClB,CAAC;QAED,gBAAgB;QAChB,IAAI,SAAS,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;QAEzC,KAAK,CAAC,SAAS,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,WAAW,CAAC,CAAC;QAEpE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1B,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;IAC3C,CAAC;IAGD;;;;OAIG;IACH,aAAa,CAAC,gBAAwB,CAAC;QACrC,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,GAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACI,UAAU;QACf,gDAAgD;QAChD,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtE,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;QACD,MAAM,eAAe,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACzD,CAAC;IAED;;;;;OAKG;IACK,WAAW,CAAC,MAAa,EAAE,QAAmB;QACpD,sCAAsC;QACtC,4DAA4D;QAC5D,MAAM,OAAO,GAAG,UAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAC,IAAI,EAAE,0CAAkB,CAAC,GAAG,EAAC,CAAC,CAAC;QAC7E,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;YACxB,OAAO,IAAI,UAAE,CAAC;gBACZ,IAAI,EAAE,IAAI,CAAC,KAAK;gBAChB,OAAO,EAAE,OAAO;aACjB,CAAC,CAAC;QACL,CAAC;QACD,OAAO,IAAI,UAAE,CAAC;YACZ,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,OAAO,EAAE,OAAO;YAChB,MAAM,EAAE,MAAM;YACd,SAAS,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM;YACrC,UAAU,EAAE,IAAI;SACjB,CAAC,CAAA;IACJ,CAAC;CACF;AA7FD,8CA6FC"}

package/dist/commonjs/classes/key.helper.d.ts

@@ -0,0 +1,27 @@
+/**
+ * This file contains helper functions for encoding and decoding keys
+ */
+/**
+ * Interface for the key to integer mapping
+ */
+export type IKeyMap = Record<string, string | number>;
+/**
+ * For some CDDL types we use integer as keys to keep the CBOR encoded data small
+ * This function converts the data keys to their respective integer values
+ *
+ * It needs to return MAP because cbor library only then encodes the keys as integers
+ *
+ * @param data Object that has key value pairs
+ * @param keyMap  Map of the keys to integers values
+ * @returns Map with integer keys
+ */
+export declare function encodeKeys(data: object, keyMap: IKeyMap, allowKeysNotInMap: boolean): Map<string | number, any>;
+/**
+ * For some CDDL types we use integer as keys to keep the CBOR encoded data small
+ * This function converts the data keys back to their respective string values
+ *
+ * @param _data Object that has encoded key - value pairs
+ * @param keyMap Map of the keys to integer values
+ * @returns Object with string keys
+ */
+export declare function decodeKeys(data: Map<string | number, any> | Record<string | number, any>, keyMap: IKeyMap, allowKeysNotInMap: boolean): object;

package/dist/commonjs/classes/key.helper.js

@@ -0,0 +1,70 @@
+"use strict";
+/**
+ * This file contains helper functions for encoding and decoding keys
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeKeys = encodeKeys;
+exports.decodeKeys = decodeKeys;
+/**
+ * For some CDDL types we use integer as keys to keep the CBOR encoded data small
+ * This function converts the data keys to their respective integer values
+ *
+ * It needs to return MAP because cbor library only then encodes the keys as integers
+ *
+ * @param data Object that has key value pairs
+ * @param keyMap  Map of the keys to integers values
+ * @returns Map with integer keys
+ */
+function encodeKeys(data, keyMap, allowKeysNotInMap) {
+    const map = new Map();
+    // If we have a mapping, use it to map the data
+    // Check if our data is an object
+    if (typeof data !== "object")
+        return undefined;
+    // Create a set from the keys of the data
+    const keys = new Set(Object.keys(data));
+    // Add the keys in the correct order to the map
+    for (const key in keyMap) {
+        // Check if the key exists in the data
+        if (data[key] !== undefined)
+            map.set(keyMap[key], data[key]);
+        keys.delete(key);
+    }
+    if (allowKeysNotInMap) {
+        // Add other keys as string if they are not existent in the map
+        keys.forEach((key) => {
+            map.set(key, data[key]);
+        });
+    }
+    return map;
+}
+/**
+ * For some CDDL types we use integer as keys to keep the CBOR encoded data small
+ * This function converts the data keys back to their respective string values
+ *
+ * @param _data Object that has encoded key - value pairs
+ * @param keyMap Map of the keys to integer values
+ * @returns Object with string keys
+ */
+function decodeKeys(data, keyMap, allowKeysNotInMap) {
+    // If we have a mapping, use it to map the data
+    const result = {};
+    // Convert the data to a map if it is not already
+    const _data = data instanceof Map ? data : new Map(Object.entries(data));
+    // Get all the keys in the data
+    const keys = new Set(_data.keys());
+    // Add the keys in the correct order
+    for (const key in keyMap) {
+        if (_data.has(keyMap[key]))
+            result[key] = _data.get(keyMap[key]);
+        keys.delete(keyMap[key]);
+    }
+    if (allowKeysNotInMap) {
+        // Add other keys as string if they are not existent in the map
+        keys.forEach((key) => {
+            result[key] = _data.get(key);
+        });
+    }
+    return result;
+}
+//# sourceMappingURL=key.helper.js.map

package/dist/commonjs/classes/key.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"key.helper.js","sourceRoot":"","sources":["../../../src/classes/key.helper.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAiBH,gCA4BC;AAUD,gCA2BC;AA3ED;;;;;;;;;GASG;AACH,SAAgB,UAAU,CACxB,IAAY,EACZ,MAAe,EACf,iBAA0B;IAE1B,MAAM,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;IACtB,+CAA+C;IAC/C,iCAAiC;IACjC,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAE/C,yCAAyC;IACzC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAExC,+CAA+C;IAC/C,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QACzB,sCAAsC;QACtC,IAAG,IAAI,CAAC,GAAG,CAAC,KAAK,SAAS;YAAE,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC;IAED,IAAI,iBAAiB,EAAE,CAAC;QACtB,+DAA+D;QAC/D,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CACxB,IAA8D,EAC9D,MAAe,EACf,iBAA0B;IAE1B,+CAA+C;IAC/C,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,iDAAiD;IACjD,MAAM,KAAK,GAAG,IAAI,YAAY,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAEzE,+BAA+B;IAC/B,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IAEnC,oCAAoC;IACpC,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QACzB,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAAE,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QACjE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3B,CAAC;IAED,IAAI,iBAAiB,EAAE,CAAC;QACtB,+DAA+D;QAC/D,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/commonjs/encodingMethods/BytewordEncoding.d.ts

@@ -0,0 +1,11 @@
+import { STYLES } from "./bytewords.js";
+import { EncodingMethodName } from "../enums/EncodingMethodName.js";
+import { IEncodingMethod } from "../interfaces/IEncodingMethod.js";
+export declare class BytewordEncoding implements IEncodingMethod<string, string> {
+    private _name;
+    readonly _style: STYLES;
+    get name(): EncodingMethodName;
+    constructor(style?: STYLES);
+    encode(payload: string): string;
+    decode(payload: string): string;
+}