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

package/dist/commonjs/classes/FountainEncoder.js

@@ -0,0 +1,168 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FountainEncoder = void 0;
+const fountainUtils_js_1 = require("../helpers/fountainUtils.js");
+const utils_js_1 = require("../helpers/utils.js");
+const CborEncoding_js_1 = require("../encodingMethods/CborEncoding.js");
+const cborEncoder = new CborEncoding_js_1.CborEncoding();
+/**
+ * Encode data on the fly. This encoder uses an internal state to keep generating ur fragments of the payload.
+ */
+class FountainEncoder {
+    fragmentLenghtFinder = fountainUtils_js_1.findNominalFragmentLength;
+    /** Total data size of the input message */
+    _messageLength;
+    /** Maximum data size in the fragment */
+    _maxFragmentLength;
+    /** Minumum data size in the fragment */
+    _minFragmentLength;
+    /** Calculated data size in the fragment */
+    _nominalFragmentLength;
+    /** Array of pure fragments (without any fountain encoded) */
+    _pureFragments;
+    /** Current index of the fragment start from 1 */
+    _seqNum;
+    /** Checksum of the original data */
+    _checksum;
+    /** Original Input data as UR */
+    _input;
+    constructor(input, maxFragmentLength = 100, minFragmentLength = 10, firstSeqNum = 0) {
+        // Validate the input
+        if (!input) {
+            throw new Error("input should be defined");
+        }
+        if (!(input instanceof Uint8Array)) {
+            throw new Error("input should be Uint8Array");
+        }
+        if (typeof maxFragmentLength !== "number") {
+            throw new Error("maxFragmentLength should be a number");
+        }
+        if (typeof minFragmentLength !== "number") {
+            throw new Error("minFragmentLength should be a number");
+        }
+        if (typeof firstSeqNum !== "number") {
+            throw new Error("firstSeqNum should be a number");
+        }
+        if (maxFragmentLength < 1) {
+            throw new Error("maxFragmentLength should be > 0");
+        }
+        if (maxFragmentLength < minFragmentLength) {
+            throw new Error("maxFragmentLength should be >= minFragmentLength");
+        }
+        this._input = input;
+        this._maxFragmentLength = maxFragmentLength;
+        this._minFragmentLength = minFragmentLength;
+        this._seqNum = (0, utils_js_1.toUint32)(firstSeqNum);
+        // Get the length of the message
+        this._messageLength = input.length;
+        // Check if message is less than maxFragmentLength, then return the message as a single fragment
+        if (input.length <= maxFragmentLength) {
+            this._pureFragments = [input];
+            this._nominalFragmentLength = this._messageLength;
+        }
+        // Otherwise calciulate the nominal fragment length and neseccary fragments
+        else {
+            // Check for the nominal length of a fragment.
+            const fragmentLength = this.fragmentLenghtFinder(input.length, maxFragmentLength, minFragmentLength);
+            this._nominalFragmentLength = fragmentLength;
+            // Calculate the checksum of the message
+            this._checksum = (0, utils_js_1.getCRC)(input);
+            // Split up the message buffer in an array of buffers, by the nominal length
+            this._pureFragments = (0, fountainUtils_js_1.partitionMessage)(input, fragmentLength);
+        }
+    }
+    setFragmentLengthFinder(fn) {
+        this.fragmentLenghtFinder = fn;
+    }
+    /**
+     * 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
+     */
+    getAllParts(fountainRatio = 0) {
+        // First check if the input is a single fragment
+        if (this.isSinglePart()) {
+            return [this._input];
+        }
+        // Ceil to always get an integer
+        const numberofParts = Math.ceil(this.getPureFragmentCount() * (1 + fountainRatio));
+        // Save state
+        const oldSeqNum = this._seqNum;
+        // Reset state to start generating fragments from the beginning
+        this._seqNum = 0;
+        // Generate fragments
+        let fragments = [];
+        for (let i = 0; i < numberofParts; i++) {
+            fragments.push(this.nextPart());
+        }
+        // Bring state back
+        this._seqNum = oldSeqNum;
+        return fragments;
+    }
+    // Encode fragment with correct CBOR structure
+    encodeFragment(seqNum, fragment) {
+        // Shape for the CBOR payload
+        const payload = [seqNum, this._pureFragments.length, this._messageLength, this._checksum, fragment];
+        const encodedFragment = cborEncoder.encode(payload);
+        return encodedFragment;
+    }
+    /**
+     * Reset the state of the encoder to start generating fragments from the beginning.
+     */
+    reset() {
+        this._seqNum = 0;
+    }
+    /**
+     * Checks if all the pure fragments (full payload data) for this ur is generated.
+     * @returns boolean indicating if generated fragments have included all the data.
+     */
+    isComplete() {
+        return this._seqNum >= this.getPureFragmentCount();
+    }
+    /**
+     * Checks if there is only one fragment generated for the ur.
+     * @returns boolean if the ur payload is contained in one fragment.
+     */
+    isSinglePart() {
+        return this.getPureFragmentCount() === 1;
+    }
+    /**
+     * Gets the count of the "pure" fragments. These are fragments where the data is not mixed.
+     * @returns The count of the "pure" fragments.
+     */
+    getPureFragmentCount() {
+        return this._pureFragments.length;
+    }
+    /**
+     * Get the pure fragments of the ur.
+     * @returns the pure fragments of the ur as an array of Uint8Arrays.
+     */
+    getPureFragments() {
+        return this._pureFragments;
+    }
+    /**
+     * Give the 'next' fragment for the ur for which the fountainEncoder was created.
+     * @returns the 'next' fragment, represented as a Ur multipart string.
+     */
+    nextPart() {
+        this._seqNum = (0, utils_js_1.toUint32)(this._seqNum + 1);
+        // when the seqnum restarts because of a number bigger than Uint32, we need to make sure to skip 0 to prevent invalid Multipart URs.
+        if (this._seqNum === 0) {
+            this._seqNum = (0, utils_js_1.toUint32)(this._seqNum + 1);
+        }
+        // If its single part, return the original input
+        if (this.isSinglePart()) {
+            return this._input;
+        }
+        // For the first seqNum of the pure fragments, return the pure fragment
+        if (!this.isComplete()) {
+            return this.encodeFragment(this._seqNum, this._pureFragments[this._seqNum - 1]);
+        }
+        // For the fountain fragments, mix the fragments
+        const indexes = (0, fountainUtils_js_1.chooseFragments)(this._seqNum, this._pureFragments.length, this._checksum);
+        const mixed = (0, fountainUtils_js_1.mixFragments)(indexes, this._pureFragments, this._nominalFragmentLength);
+        return this.encodeFragment(this._seqNum, mixed);
+    }
+}
+exports.FountainEncoder = FountainEncoder;
+//# sourceMappingURL=FountainEncoder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FountainEncoder.js","sourceRoot":"","sources":["../../../src/classes/FountainEncoder.ts"],"names":[],"mappings":";;;AAAA,kEAAyH;AACzH,kDAAuD;AACvD,wEAAkE;AAElE,MAAM,WAAW,GAAG,IAAI,8BAAY,EAAE,CAAC;AAKvC;;GAEG;AACH,MAAa,eAAe;IACnB,oBAAoB,GAAG,4CAAyB,CAAC;IAExD,2CAA2C;IACpC,cAAc,CAAS;IAC9B,wCAAwC;IAC9B,kBAAkB,CAAS;IACrC,wCAAwC;IAC9B,kBAAkB,CAAS;IACrC,2CAA2C;IACpC,sBAAsB,CAAS;IACtC,6DAA6D;IACtD,cAAc,CAAe;IACpC,iDAAiD;IACvC,OAAO,CAAS;IAC1B,oCAAoC;IAC1B,SAAS,CAAS;IAC5B,gCAAgC;IACtB,MAAM,CAAa;IAE7B,YACE,KAAiB,EACjB,oBAA4B,GAAG,EAC/B,oBAA4B,EAAE,EAC9B,cAAsB,CAAC;QAIvB,qBAAqB;QACrB,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QAED,IAAG,CAAC,CAAC,KAAK,YAAY,UAAU,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;QAC/C,CAAC;QAED,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,iBAAiB,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QAED,IAAG,iBAAiB,GAAG,iBAAiB,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACtE,CAAC;QAGD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;QAC5C,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,IAAA,mBAAQ,EAAC,WAAW,CAAC,CAAC;QAErC,gCAAgC;QAChC,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC;QAEnC,gGAAgG;QAChG,IAAI,KAAK,CAAC,MAAM,IAAI,iBAAiB,EAAE,CAAC;YACtC,IAAI,CAAC,cAAc,GAAG,CAAC,KAAK,CAAC,CAAC;YAC9B,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,cAAc,CAAC;QACpD,CAAC;QACD,2EAA2E;aACtE,CAAC;YACJ,8CAA8C;YAC9C,MAAM,cAAc,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,MAAM,EAAE,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;YACrG,IAAI,CAAC,sBAAsB,GAAG,cAAc,CAAC;YAC7C,wCAAwC;YACxC,IAAI,CAAC,SAAS,GAAG,IAAA,iBAAM,EAAC,KAAK,CAAC,CAAC;YAC/B,4EAA4E;YAC5E,IAAI,CAAC,cAAc,GAAG,IAAA,mCAAgB,EAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IAED,uBAAuB,CAAC,EAAoC;QAC1D,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,gBAAwB,CAAC;QACnC,gDAAgD;QAChD,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;YACxB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvB,CAAC;QACD,gCAAgC;QAChC,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC;QACnF,aAAa;QACb,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC;QAC/B,+DAA+D;QAC/D,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;QACjB,qBAAqB;QACrB,IAAI,SAAS,GAAG,EAAE,CAAA;QAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAClC,CAAC;QACD,mBAAmB;QACnB,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QACzB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,8CAA8C;IACpC,cAAc,CAAC,MAAa,EAAE,QAAmB;QACzD,6BAA6B;QAC7B,MAAM,OAAO,GAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QACzH,MAAM,eAAe,GAAG,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAEpD,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;IACnB,CAAC;IAGD;;;OAGG;IACI,UAAU;QACf,OAAO,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACI,oBAAoB;QACzB,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;IACpC,CAAC;IAED;;;OAGG;IACI,gBAAgB;QACrB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,IAAI,CAAC,OAAO,GAAG,IAAA,mBAAQ,EAAC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;QAE1C,oIAAoI;QACpI,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,OAAO,GAAG,IAAA,mBAAQ,EAAC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;QAC5C,CAAC;QAED,gDAAgD;QAChD,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;QAED,uEAAuE;QACvE,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;QAClF,CAAC;QAED,gDAAgD;QAChD,MAAM,OAAO,GAAG,IAAA,kCAAe,EAC7B,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,cAAc,CAAC,MAAM,EAC1B,IAAI,CAAC,SAAS,CACf,CAAC;QACF,MAAM,KAAK,GAAG,IAAA,+BAAY,EACxB,OAAO,EACP,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,sBAAsB,CAC5B,CAAC;QAEF,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;CACF;AAtMD,0CAsMC"}

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

@@ -0,0 +1,104 @@
+import { UR } from "./UR.js";
+import { encodeKeys, decodeKeys, IKeyMap } from "./key.helper.js";
+export declare const registryItemSymbol: unique symbol;
+/**
+ * Static interface that RegistryItem classes should implement
+ */
+export interface IRegistryType {
+    /**
+     * Cbor Tags
+     * Finalized versions defined in: https://www.iana.org/assignments/cbor-tags/cbor-tags.xhtml
+     */
+    tag: number;
+    /**
+     * Uniform Resource ID
+     *
+     * Links:
+     * - https://developer.blockchaincommons.com/ur/
+     * - https://github.com/BlockchainCommons/Research/blob/master/papers/bcr-2020-006-urtypes.md
+     * - https://github.com/ngraveio/Research
+     * - https://github.com/KeystoneHQ/Keystone-developer-hub/tree/main/research
+     *
+     */
+    URType: string;
+    /** CDDL definition for CBOR encoding */
+    CDDL: string;
+    /** Key name to key in integer map for smaller encoded data size */
+    keyMap?: IKeyMap;
+    /** allow the keys that are not explicitely defined in the keyMap */
+    allowKeysNotInMap?: boolean;
+}
+export declare abstract class RegistryItemBase {
+    readonly type: IRegistryType;
+    /** If CDDL contains keys as numbers, map them to their respective values */
+    keyMap: IKeyMap;
+    /** Data that our item contains */
+    data: any;
+    static allowKeysNotInMap: any;
+    constructor(registryType: IRegistryType, data?: any, keyMap?: IKeyMap);
+    /**
+     * Verify the input data
+     *
+     * @param input
+     */
+    verifyInput(input: any): {
+        valid: boolean;
+        reasons?: Error[];
+    };
+    toString(): string;
+    toJSON(): any;
+    /**
+     * Preprocess the data before encoding into CBOR Tagged instance
+     *
+     * @param data, data before keymap conversion, if left empty, it will use the this.data property
+     */
+    preCBOR(data?: any): any;
+    /**
+     * Called by the CBOR encoder for encoding the data
+     *
+     * [CBOR Docs](https://github.com/hildjj/cbor2?tab=readme-ov-file#tocbor-method)
+     *
+     * This is the easiest approach, if you can modify the class being encoded.
+     * Add a toCBOR() method to your class, which should return a two-element array containing the tag number and data item that encodes your class.
+     * If the tag number is NaN, no tag will be written. If you return undefined, nothing will be written.
+     * In this case you will likely write custom bytes to the Writer instance that is passed in,
+     * perhaps using the encoding options.
+     *
+     * @param encoder
+     * @returns
+     */
+    toCBOR(_writer: any, _options: any): any[];
+    toUr(): UR;
+    toHex(): string;
+    toBytes(): Uint8Array<ArrayBufferLike>;
+    encodeKeys: typeof encodeKeys;
+    decodeKeys: typeof decodeKeys;
+}
+/**
+ * Factory function to create a new RegistryItem class
+ *
+ * It injects static properties to the class and does preprocessing when needed
+ *
+ * @param input
+ * @returns
+ */
+export declare function registryItemFactory<T extends RegistryItemBase>(input: IRegistryType): RegistryItemClass<T>;
+export type RegistryItemClass<T extends RegistryItemBase = RegistryItemBase> = {
+    new (...args: any[]): T;
+    tag: number;
+    URType: string;
+    CDDL: string;
+    keyMap?: IKeyMap;
+    allowKeysNotInMap: boolean;
+    postCBOR(val: any, allowKeysNotInMapOverwrite?: boolean): any;
+    fromCBORData(val: any, allowKeysNotInMap?: boolean, tagged?: any): T;
+    fromUr(ur: UR | string): T;
+    fromHex(hex: string): T;
+};
+export type RegistryItem = InstanceType<RegistryItemClass>;
+/**
+ * Function to check if an object is an instance of RegistryItemBase or its subclasses
+ * @param obj - The object to check
+ * @returns true if the object is an instance of RegistryItemBase or its subclasses
+ */
+export declare function isRegistryItem(obj: any): obj is RegistryItem;

package/dist/commonjs/classes/RegistryItem.js

@@ -0,0 +1,172 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegistryItemBase = exports.registryItemSymbol = void 0;
+exports.registryItemFactory = registryItemFactory;
+exports.isRegistryItem = isRegistryItem;
+const UR_js_1 = require("./UR.js");
+const key_helper_js_1 = require("./key.helper.js");
+// Define the symbol
+exports.registryItemSymbol = Symbol.for("RegistryItemBase");
+class RegistryItemBase {
+    type;
+    /** If CDDL contains keys as numbers, map them to their respective values */
+    keyMap;
+    /** Data that our item contains */
+    // TODO: should we force this to be a map? It is much safer that way for injection attacks
+    data;
+    static allowKeysNotInMap;
+    constructor(registryType, data, keyMap) {
+        this.type = registryType;
+        this.keyMap = keyMap;
+        // Verify input
+        const { valid, reasons } = this.verifyInput(data);
+        if (!valid) {
+            throw new Error(`Invalid input: ${reasons?.map((r) => r.message).join(", ")}`);
+        }
+        this.data = data;
+        this[exports.registryItemSymbol] = true;
+    }
+    /**
+     * Verify the input data
+     *
+     * @param input
+     */
+    verifyInput(input) {
+        // This should be implemented by the child class
+        return {
+            valid: true,
+            reasons: undefined,
+        };
+    }
+    toString() {
+        return `${this.type.URType}[${this.type.tag}](${JSON.stringify(this.data)})`;
+    }
+    toJSON() {
+        // TODO: if there is any registry item in the data (could be nested or in array), we should call toJSON on them as well
+        return {
+            type: this.type.URType,
+            tag: this.type.tag,
+            ...this.data,
+        };
+    }
+    /**
+     * Preprocess the data before encoding into CBOR Tagged instance
+     *
+     * @param data, data before keymap conversion, if left empty, it will use the this.data property
+     */
+    preCBOR(data = this.data) {
+        // If key-map exists, convert keys to integers
+        if (this.keyMap) {
+            const allowKeysNotInMap = this.constructor.allowKeysNotInMap;
+            return (0, key_helper_js_1.encodeKeys)(data, this.keyMap, allowKeysNotInMap);
+        }
+        return data;
+    }
+    /**
+     * Called by the CBOR encoder for encoding the data
+     *
+     * [CBOR Docs](https://github.com/hildjj/cbor2?tab=readme-ov-file#tocbor-method)
+     *
+     * This is the easiest approach, if you can modify the class being encoded.
+     * Add a toCBOR() method to your class, which should return a two-element array containing the tag number and data item that encodes your class.
+     * If the tag number is NaN, no tag will be written. If you return undefined, nothing will be written.
+     * In this case you will likely write custom bytes to the Writer instance that is passed in,
+     * perhaps using the encoding options.
+     *
+     * @param encoder
+     * @returns
+     */
+    toCBOR(_writer, _options) {
+        const processed = this.preCBOR(this.data);
+        let tag = this.type.tag;
+        // TODO: find a better way to ignore top level tag on encoder
+        if (_options?.ignoreTopLevelTag) {
+            tag = NaN; // Do not tag the top level item
+            // Set it back to false for child items
+            _options.ignoreTopLevelTag = false;
+        }
+        return [tag, processed];
+    }
+    toUr() {
+        return new UR_js_1.UR(this);
+    }
+    toHex() {
+        return this.toUr().getPayloadHex();
+    }
+    toBytes() {
+        return this.toUr().getPayloadCbor();
+    }
+    encodeKeys = key_helper_js_1.encodeKeys;
+    decodeKeys = key_helper_js_1.decodeKeys;
+    // Custom inspection method for Node.js
+    [Symbol.for("nodejs.util.inspect.custom")](_depth, inspectOptions, inspect) {
+        return `${this.type.URType}[${this.type.tag}](${inspect(this.data, inspectOptions)})`;
+    }
+}
+exports.RegistryItemBase = RegistryItemBase;
+/**
+ * Factory function to create a new RegistryItem class
+ *
+ * It injects static properties to the class and does preprocessing when needed
+ *
+ * @param input
+ * @returns
+ */
+function registryItemFactory(input) {
+    const { tag, URType, CDDL, keyMap, allowKeysNotInMap = true } = input;
+    const _keyMap = keyMap;
+    return class extends RegistryItemBase {
+        // Add static properties to the class
+        static tag = tag;
+        static URType = URType;
+        static CDDL = CDDL;
+        static keyMap = _keyMap;
+        static allowKeysNotInMap = allowKeysNotInMap;
+        // Initiate base class with the values
+        constructor(data, keyMap = _keyMap) {
+            super(input, data, keyMap);
+        }
+        /**
+         * Post process the data after decoding CBOR
+         */
+        static postCBOR(val, allowKeysNotInMapOverwrite) {
+            // If key-map exists, convert integer keys back to string keys
+            if (keyMap) {
+                return (0, key_helper_js_1.decodeKeys)(val, keyMap, allowKeysNotInMapOverwrite ?? allowKeysNotInMap);
+            }
+            return val;
+        }
+        static fromUr(ur) {
+            const urObj = typeof ur === "string" ? UR_js_1.UR.fromString(ur) : ur;
+            const decoded = urObj.decode();
+            return decoded;
+        }
+        static fromHex(hex) {
+            const ur = UR_js_1.UR.fromHex({ type: URType, payload: hex });
+            const decoded = ur.decode();
+            return decoded;
+        }
+        /**
+         * Static method to create an instance from CBOR DataItem data.
+         * It processes the raw CBOR data if needed and returns a new instance of the class.
+         */
+        static fromCBORData(val, allowKeysNotInMap, tagged) {
+            // Do some post processing data coming from the cbor decoder
+            const data = this.postCBOR(val, allowKeysNotInMap);
+            // Return an instance of the generated class
+            return new this(data);
+        }
+    };
+}
+/**
+ * Function to check if an object is an instance of RegistryItemBase or its subclasses
+ * @param obj - The object to check
+ * @returns true if the object is an instance of RegistryItemBase or its subclasses
+ */
+function isRegistryItem(obj) {
+    return (obj instanceof RegistryItemBase ||
+        (obj && obj[exports.registryItemSymbol] === true) ||
+        //(obj && typeof obj.toCBOR === 'function' && typeof obj.toUr === 'function' && typeof obj.toHex === 'function' && typeof obj.toBytes === 'function' && obj.type !== undefined && obj.data !== undefined)
+        (obj && typeof obj.toCBOR === 'function' && typeof obj.toUr === 'function' && typeof obj.toHex === 'function' && obj.type !== undefined && obj.data !== undefined));
+}
+//# sourceMappingURL=RegistryItem.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RegistryItem.js","sourceRoot":"","sources":["../../../src/classes/RegistryItem.ts"],"names":[],"mappings":";;;AA2JA,kDAuDC;AAsBD,wCAOC;AA/OD,mCAA6B;AAC7B,mDAAkE;AAElE,oBAAoB;AACP,QAAA,kBAAkB,GAAG,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;AA8BjE,MAAsB,gBAAgB;IAC3B,IAAI,CAAgB;IAC7B,4EAA4E;IAC5E,MAAM,CAAU;IAChB,kCAAkC;IAClC,0FAA0F;IAC1F,IAAI,CAAM;IACV,MAAM,CAAC,iBAAiB,CAAM;IAE9B,YAAY,YAA2B,EAAE,IAAU,EAAE,MAAgB;QACnE,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,eAAe;QACf,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,kBAAkB,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjF,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAChB,IAAY,CAAC,0BAAkB,CAAC,GAAG,IAAI,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,KAAU;QACpB,gDAAgD;QAChD,OAAO;YACL,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,SAAS;SACnB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IAC/E,CAAC;IAED,MAAM;QACJ,uHAAuH;QACvH,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;YACtB,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG;YAClB,GAAG,IAAI,CAAC,IAAI;SACb,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI;QACtB,8CAA8C;QAC9C,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,iBAAiB,GAAI,IAAI,CAAC,WAAuC,CAAC,iBAAiB,CAAC;YAC1F,OAAO,IAAA,0BAAU,EAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,OAAO,EAAE,QAAQ;QACtB,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;QACxB,6DAA6D;QAC7D,IAAI,QAAQ,EAAE,iBAAiB,EAAE,CAAC;YAChC,GAAG,GAAG,GAAG,CAAC,CAAC,gCAAgC;YAC3C,uCAAuC;YACvC,QAAQ,CAAC,iBAAiB,GAAG,KAAK,CAAC;QACrC,CAAC;QACD,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI;QACF,OAAO,IAAI,UAAE,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAED,KAAK;QACH,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,aAAa,EAAE,CAAC;IACrC,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,cAAc,EAAE,CAAC;IACtC,CAAC;IAEM,UAAU,GAAG,0BAAU,CAAC;IACxB,UAAU,GAAG,0BAAU,CAAC;IAE/B,uCAAuC;IAChC,CAAC,MAAM,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC,CAC/C,MAAc,EACd,cAAsB,EACtB,OAAgD;QAEhD,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,GAAG,CAAC;IACxF,CAAC;CACF;AA/GD,4CA+GC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAA6B,KAAoB;IAClF,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;IACtE,MAAM,OAAO,GAAG,MAAM,CAAC;IAEvB,OAAO,KAAM,SAAQ,gBAAgB;QACnC,qCAAqC;QACrC,MAAM,CAAC,GAAG,GAAW,GAAG,CAAC;QACzB,MAAM,CAAC,MAAM,GAAW,MAAM,CAAC;QAC/B,MAAM,CAAC,IAAI,GAAW,IAAI,CAAC;QAC3B,MAAM,CAAC,MAAM,GAAY,OAAO,CAAC;QACjC,MAAM,CAAC,iBAAiB,GAAY,iBAAiB,CAAC;QAEtD,sCAAsC;QACtC,YAAY,IAAU,EAAE,SAAkB,OAAO;YAC/C,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC7B,CAAC;QAED;;WAEG;QACH,MAAM,CAAC,QAAQ,CAAC,GAAQ,EAAE,0BAAoC;YAC5D,8DAA8D;YAC9D,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO,IAAA,0BAAU,EAAC,GAAG,EAAE,MAAM,EAAE,0BAA0B,IAAI,iBAAiB,CAAC,CAAC;YAClF,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QAED,MAAM,CAAC,MAAM,CAAC,EAAe;YAC3B,MAAM,KAAK,GAAG,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9D,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,EAAa,CAAC;YAE1C,OAAO,OAAY,CAAC;QACtB,CAAC;QAED,MAAM,CAAC,OAAO,CAAC,GAAW;YACxB,MAAM,EAAE,GAAG,UAAE,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;YACtD,MAAM,OAAO,GAAG,EAAE,CAAC,MAAM,EAAa,CAAC;YAEvC,OAAO,OAAY,CAAC;QACtB,CAAC;QAED;;;WAGG;QACH,MAAM,CAAC,YAAY,CAAC,GAAQ,EAAE,iBAA2B,EAAE,MAAY;YACrE,4DAA4D;YAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;YAEnD,4CAA4C;YAC5C,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;KAEsB,CAAC;AAC5B,CAAC;AAiBD;;;;GAIG;AACH,SAAgB,cAAc,CAAC,GAAQ;IACrC,OAAO,CACL,GAAG,YAAY,gBAAgB;QAC/B,CAAC,GAAG,IAAI,GAAG,CAAC,0BAAkB,CAAC,KAAK,IAAI,CAAC;QACzC,yMAAyM;QACzM,CAAC,GAAG,IAAI,OAAO,GAAG,CAAC,MAAM,KAAK,UAAU,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,UAAU,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,UAAU,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CACnK,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,89 @@
+import { RegistryItem, RegistryItemBase } from "./RegistryItem.js";
+import { EncodingMethodName } from "../enums/EncodingMethodName.js";
+import { EncodingPipeline } from "../encodingMethods/pipeline.js";
+import { ReplaceKeyType } from "../helpers/type.helper.js";
+export interface IUR {
+    type: string;
+    payload: string;
+    seqNum?: number;
+    seqLength?: number;
+    isFragment?: boolean;
+}
+/**
+ * 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?
+ */
+export declare class UR {
+    type: string;
+    payload: string;
+    seqNum?: number;
+    seqLength?: number;
+    isFragment: boolean;
+    static pipeline: EncodingPipeline<any, string>;
+    constructor(input: IUR | RegistryItem);
+    decode(until?: EncodingMethodName): any;
+    toString(): string;
+    getPayloadBytewords(): string;
+    getPayloadHex(): string;
+    getPayloadCbor(): Uint8Array<ArrayBufferLike>;
+    toRegistryItem(): RegistryItemBase;
+    static fromRegistryItem(item: RegistryItem): UR;
+    /**
+     * Create UR from native javascript types by encoding them to bytewords
+     * @param input
+     * @returns
+     */
+    static fromData(input: ReplaceKeyType<IUR, 'payload', any>): UR;
+    static fromCbor(input: ReplaceKeyType<IUR, 'payload', Uint8Array>): UR;
+    static fromHex(input: ReplaceKeyType<IUR, 'payload', string>): UR;
+    static fromBytewords(input: IUR): UR;
+    static from(input: ReplaceKeyType<IUR, 'payload', any>, type: EncodingMethodName): UR;
+    static fromString(ur: string): UR;
+    static encode: typeof UR.fromRegistryItem;
+    static decode(ur: UR): RegistryItem;
+    /**
+     * 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: string): boolean;
+    /**
+     * 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: string, payload: string, seqNum?: number, seqLen?: number): string;
+    /**
+     * Parses a UR and performs basic validation
+     * @param message e.g. "UR:BYTES/6-23/LPAMCHCFATTTCYCLEHGSDPHDHGEHFGHKKKDL..."
+     */
+    static parseUr(message: string): IUR;
+}
+/**
+ * [seqNum, fragments.length, totalPayloadLength, checksum, fragment]
+ *
+ * part = [
+ *	uint32 seqNum,
+ *	uint seqLen,
+ *	uint messageLen,
+ *	uint32 checksum,
+ *	bytes data
+ *  ]
+ */
+export type IMultipartUrPayload = [number, number, number, number, Uint8Array];