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

package/dist/esm/encodingMethods/BytewordEncoding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BytewordEncoding.js","sourceRoot":"","sources":["../../../src/encodingMethods/BytewordEncoding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAGpE,MAAM,OAAO,gBAAgB;IACnB,KAAK,GAAuB,kBAAkB,CAAC,SAAS,CAAC;IAExD,MAAM,CAAS;IAExB,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED,YAAY,QAAgB,MAAM,CAAC,OAAO;QACxC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IACD,MAAM,CAAC,OAAe;QACpB,OAAO,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IACD,MAAM,CAAC,OAAe;QACpB,OAAO,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;CACF"}

package/dist/esm/encodingMethods/CborEncoding.d.ts

@@ -0,0 +1,44 @@
+import { URRegistryClass } from "../registry.js";
+import { RegistryItem, RegistryItemClass } from "../classes/RegistryItem.js";
+import { EncodingMethodName } from "../enums/EncodingMethodName.js";
+import { IEncodingMethod } from "../interfaces/IEncodingMethod.js";
+import { DecodeOptions, EncodeOptions } from "../wrappers/cbor2.js";
+interface inputOptions {
+    registry?: URRegistryClass;
+    cborLibEncoderOptions?: EncodeOptions & {
+        ignoreTopLevelTag?: boolean;
+    };
+    cborLibDecoderOptions?: DecodeOptions;
+}
+interface decodeOptions {
+    enforceType?: RegistryItemClass | string;
+    cborLibOptions?: DecodeOptions;
+}
+export declare class CborEncoding<T extends RegistryItem> implements IEncodingMethod<T, Uint8Array> {
+    private _name;
+    registry: URRegistryClass;
+    /** Decoding options for CBOR2 library */
+    cborLibEncoderOptions: EncodeOptions;
+    cborLibDecoderOptions: DecodeOptions;
+    constructor(options?: inputOptions);
+    get name(): EncodingMethodName;
+    /**
+     * Encode the given payload to CBOR
+     *
+     * @param payload @type RegistryItem
+     * @param cborLibOptions @type EncodeOptions
+     * @returns @type Uint8Array
+     */
+    encode(payload: any, cborLibOptions?: EncodeOptions & {
+        ignoreTopLevelTag?: boolean;
+    }): Uint8Array;
+    /**
+     * Decode the CBOR encoded payload to the given type
+     * @param payload @type Uint8Array
+     * @param enforceType Forces decoding into given type or throws error if it cannot be decoded @type RegistryItemClass
+     * @param cborLibOptions @type DecodeOptions
+     * @returns @type T
+     */
+    decode(payload: Uint8Array, options?: decodeOptions): T;
+}
+export {};

package/dist/esm/encodingMethods/CborEncoding.js

@@ -0,0 +1,147 @@
+import { UrRegistry } from "../registry.js";
+import { registryItemFactory } from "../classes/RegistryItem.js";
+import { EncodingMethodName } from "../enums/EncodingMethodName.js";
+import { decode, encode, Tag } from "../wrappers/cbor2.js";
+export class CborEncoding {
+    _name = EncodingMethodName.cbor;
+    registry = UrRegistry;
+    /** Decoding options for CBOR2 library */
+    cborLibEncoderOptions;
+    cborLibDecoderOptions;
+    constructor(options) {
+        this.cborLibEncoderOptions = options?.cborLibEncoderOptions;
+        this.cborLibDecoderOptions = options?.cborLibDecoderOptions;
+    }
+    get name() {
+        return this._name;
+    }
+    /**
+     * Encode the given payload to CBOR
+     *
+     * @param payload @type RegistryItem
+     * @param cborLibOptions @type EncodeOptions
+     * @returns @type Uint8Array
+     */
+    encode(payload, cborLibOptions) {
+        // Combine instance cborLibOptions with the given cborLibOptions
+        const combinedOptions = {
+            ...this.cborLibEncoderOptions,
+            ...cborLibOptions,
+        };
+        // By default encode return Uint8Array
+        const encoded = encode(payload, combinedOptions);
+        return encoded;
+    }
+    /**
+     * Decode the CBOR encoded payload to the given type
+     * @param payload @type Uint8Array
+     * @param enforceType Forces decoding into given type or throws error if it cannot be decoded @type RegistryItemClass
+     * @param cborLibOptions @type DecodeOptions
+     * @returns @type T
+     */
+    decode(payload, options) {
+        // Combine instance cborLibOptions with the given cborLibOptions
+        const { cborLibOptions, enforceType } = options || {};
+        const combinedOptions = {
+            ...this.cborLibDecoderOptions,
+            ...cborLibOptions,
+        };
+        const decoded = decode(payload, combinedOptions);
+        // Check if enforce type is given, if so then give the value to the enforced type
+        if (enforceType) {
+            let foundType;
+            // If enforceType is string then find the type from the registry
+            if (typeof enforceType === "string") {
+                foundType = this.registry.queryByURType(enforceType);
+            }
+            else {
+                foundType = enforceType;
+            }
+            // If we have a registry item then force the type
+            if (foundType) {
+                return forceType(decoded, foundType);
+            }
+        }
+        // If we still have a cbor tag but not registry item then return try to convert it to registry item
+        if (decoded instanceof Tag) {
+            return tag2registryItem(decoded);
+        }
+        // Otherwise just return the decoded value
+        // TODO: fix as unknown as T;
+        return decoded;
+    }
+}
+/**
+ * Force the data to be of the enforced type registry item
+ * @param data
+ * @param enforceType
+ * @returns
+ */
+function forceType(data, enforceType) {
+    // If its already the enforced type then return
+    if (data instanceof enforceType) {
+        return data;
+    }
+    // If data is CBOR tag item, try to convert it to enforced type
+    if (data instanceof Tag) {
+        if (data.tag !== enforceType.tag) {
+            throw new Error(`Enforced type does not match the tag of ${enforceType.URType}:${enforceType.tag} !== ${data.tag}`);
+        }
+        return enforceType.fromCBORData(data.contents, enforceType.allowKeysNotInMap);
+    }
+    // If data is raw then try to convert it to enforced type
+    return enforceType.fromCBORData(data, enforceType.allowKeysNotInMap);
+}
+/**
+ * Converts a CBOR tag to a registry item
+ * @param unkownTag
+ * @returns
+ */
+function tag2registryItem(unkownTag) {
+    const tag = toRegistryTagNumber(unkownTag.tag);
+    const data = unkownTag.contents;
+    const registryItem = UrRegistry.queryByTag(tag);
+    if (registryItem) {
+        return registryItem.fromCBORData(data, registryItem.allowKeysNotInMap);
+    }
+    // If we dont have the tag in the registry return unknown item
+    const UnknownTag = class extends registryItemFactory({
+        tag: tag,
+        URType: "unknown-tag",
+        CDDL: ``,
+    }) {
+    };
+    const unknownItem = new UnknownTag(data);
+    // Search through all the children in unknownItem.data if any one of them are tags
+    deepSearchObject(unknownItem.data);
+    return unknownItem;
+}
+function toRegistryTagNumber(tag) {
+    if (typeof tag === "bigint") {
+        const converted = Number(tag);
+        if (!Number.isSafeInteger(converted)) {
+            throw new Error(`CBOR tag ${tag.toString()} exceeds JavaScript safe integer range`);
+        }
+        return converted;
+    }
+    return Number(tag);
+}
+/**
+ * Search through the object and convert tags to registry items
+ * @param obj
+ * @returns
+ */
+function deepSearchObject(obj) {
+    if (typeof obj !== "object") {
+        return obj;
+    }
+    for (const key in obj) {
+        if (obj[key] instanceof Tag) {
+            obj[key] = tag2registryItem(obj[key]);
+        }
+        else if (typeof obj[key] === "object") {
+            deepSearchObject(obj[key]);
+        }
+    }
+}
+//# sourceMappingURL=CborEncoding.js.map

package/dist/esm/encodingMethods/CborEncoding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CborEncoding.js","sourceRoot":"","sources":["../../../src/encodingMethods/CborEncoding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAmC,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAClG,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAGpE,OAAO,EAGL,MAAM,EAAE,MAAM,EAAE,GAAG,EACpB,MAAM,sBAAsB,CAAC;AAa9B,MAAM,OAAO,YAAY;IAGf,KAAK,GAAuB,kBAAkB,CAAC,IAAI,CAAC;IACrD,QAAQ,GAAoB,UAAU,CAAC;IAE9C,yCAAyC;IACzC,qBAAqB,CAAgB;IACrC,qBAAqB,CAAgB;IAErC,YAAY,OAAsB;QAChC,IAAI,CAAC,qBAAqB,GAAG,OAAO,EAAE,qBAAqB,CAAC;QAC5D,IAAI,CAAC,qBAAqB,GAAG,OAAO,EAAE,qBAAqB,CAAC;IAC9D,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAY,EAAE,cAA8D;QACjF,gEAAgE;QAChE,MAAM,eAAe,GAAG;YACtB,GAAG,IAAI,CAAC,qBAAqB;YAC7B,GAAG,cAAc;SAClB,CAAC;QAEF,sCAAsC;QACtC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QACjD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CACJ,OAAmB,EACnB,OAAuB;QAEvB,gEAAgE;QAChE,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QACtD,MAAM,eAAe,GAAG;YACtB,GAAG,IAAI,CAAC,qBAAqB;YAC7B,GAAG,cAAc;SAClB,CAAC;QAEF,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAEjD,iFAAiF;QACjF,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,SAA4B,CAAC;YACjC,gEAAgE;YAChE,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;gBACpC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YACvD,CAAC;iBACI,CAAC;gBACJ,SAAS,GAAG,WAAW,CAAC;YAC1B,CAAC;YAED,iDAAiD;YACjD,IAAI,SAAS,EAAE,CAAC;gBACd,OAAO,SAAS,CAAC,OAAO,EAAE,SAAS,CAAiB,CAAC;YACvD,CAAC;QACH,CAAC;QAED,mGAAmG;QACnG,IAAI,OAAO,YAAY,GAAG,EAAE,CAAC;YAC3B,OAAO,gBAAgB,CAAC,OAAO,CAAiB,CAAC;QACnD,CAAC;QAED,0CAA0C;QAC1C,6BAA6B;QAC7B,OAAO,OAAuB,CAAC;IACjC,CAAC;CACF;AAED;;;;;GAKG;AACH,SAAS,SAAS,CAAC,IAAS,EAAE,WAA8B;IAC1D,+CAA+C;IAC/C,IAAI,IAAI,YAAY,WAAW,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+DAA+D;IAC/D,IAAI,IAAI,YAAY,GAAG,EAAE,CAAC;QACxB,IAAI,IAAI,CAAC,GAAG,KAAK,WAAW,CAAC,GAAG,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CACb,2CAA2C,WAAW,CAAC,MAAM,IAAI,WAAW,CAAC,GAAG,QAAQ,IAAI,CAAC,GAAG,EAAE,CACnG,CAAC;QACJ,CAAC;QACD,OAAO,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAChF,CAAC;IAED,yDAAyD;IACzD,OAAO,WAAW,CAAC,YAAY,CAAC,IAAI,EAAE,WAAW,CAAC,iBAAiB,CAAC,CAAC;AACvE,CAAC;AAED;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,SAAc;IACtC,MAAM,GAAG,GAAG,mBAAmB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC/C,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC;IAEhC,MAAM,YAAY,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAChD,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO,YAAY,CAAC,YAAY,CAC9B,IAAI,EACJ,YAAY,CAAC,iBAAiB,CAC/B,CAAC;IACJ,CAAC;IAED,8DAA8D;IAC9D,MAAM,UAAU,GAAG,KAAM,SAAQ,mBAAmB,CAAC;QACnD,GAAG,EAAE,GAAG;QACR,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,EAAE;KACT,CAAC;KAAG,CAAC;IAEN,MAAM,WAAW,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;IAEzC,kFAAkF;IAClF,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAEnC,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,mBAAmB,CAAC,GAAe;IAC1C,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,CAAC,QAAQ,EAAE,wCAAwC,CAAC,CAAC;QACtF,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,GAAQ;IAChC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,GAAG,CAAC;IACb,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,IAAI,GAAG,CAAC,GAAG,CAAC,YAAY,GAAG,EAAE,CAAC;YAC5B,GAAG,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACxC,CAAC;aAAM,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;YACxC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/esm/encodingMethods/HexEncoding.d.ts

@@ -0,0 +1,8 @@
+import { EncodingMethodName } from "../enums/EncodingMethodName.js";
+import { IEncodingMethod } from "../interfaces/IEncodingMethod.js";
+export declare class HexEncoding implements IEncodingMethod<Uint8Array, string> {
+    private _name;
+    get name(): EncodingMethodName;
+    encode(payload: Uint8Array): string;
+    decode(payload: string): Uint8Array;
+}

package/dist/esm/encodingMethods/HexEncoding.js

@@ -0,0 +1,20 @@
+import { hexToUint8Array, uint8ArrayToHex } from "../helpers/uintArrayHelper.js";
+import { EncodingMethodName } from "../enums/EncodingMethodName.js";
+export class HexEncoding {
+    _name = EncodingMethodName.hex;
+    get name() {
+        return this._name;
+    }
+    encode(payload) {
+        // return payload.toString("hex");
+        return uint8ArrayToHex(payload);
+    }
+    decode(payload) {
+        const hexRegex = /^[0-9a-fA-F]+$/;
+        if (!hexRegex.test(payload)) {
+            throw new Error("Invalid hex string");
+        }
+        return hexToUint8Array(payload);
+    }
+}
+//# sourceMappingURL=HexEncoding.js.map

package/dist/esm/encodingMethods/HexEncoding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HexEncoding.js","sourceRoot":"","sources":["../../../src/encodingMethods/HexEncoding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAGpE,MAAM,OAAO,WAAW;IACd,KAAK,GAAuB,kBAAkB,CAAC,GAAG,CAAC;IAE3D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,MAAM,CAAC,OAAmB;QACxB,kCAAkC;QAClC,OAAO,eAAe,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IACD,MAAM,CAAC,OAAe;QACpB,MAAM,QAAQ,GAAG,gBAAgB,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,eAAe,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;CACF"}

package/dist/esm/encodingMethods/UrEncoding.d.ts

@@ -0,0 +1,10 @@
+import { EncodingMethodName } from "../enums/EncodingMethodName.js";
+import { IEncodingMethod } from "../interfaces/IEncodingMethod.js";
+import { UR } from "../classes/UR.js";
+import { RegistryItem } from "../classes/RegistryItem.js";
+export declare class UrEncoding implements IEncodingMethod<RegistryItem, UR> {
+    private _name;
+    get name(): EncodingMethodName;
+    encode(payload: RegistryItem): UR;
+    decode(payload: UR): RegistryItem;
+}

package/dist/esm/encodingMethods/UrEncoding.js

@@ -0,0 +1,15 @@
+import { EncodingMethodName } from "../enums/EncodingMethodName.js";
+import { UR } from "../classes/UR.js";
+export class UrEncoding {
+    _name = EncodingMethodName.ur;
+    get name() {
+        return this._name;
+    }
+    encode(payload) {
+        return UR.fromRegistryItem(payload);
+    }
+    decode(payload) {
+        return payload.toRegistryItem();
+    }
+}
+//# sourceMappingURL=UrEncoding.js.map

package/dist/esm/encodingMethods/UrEncoding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UrEncoding.js","sourceRoot":"","sources":["../../../src/encodingMethods/UrEncoding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,OAAO,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAGtC,MAAM,OAAO,UAAU;IACb,KAAK,GAAuB,kBAAkB,CAAC,EAAE,CAAC;IAE1D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,MAAM,CAAC,OAAqB;QAC1B,OAAO,EAAE,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IACD,MAAM,CAAC,OAAW;QAChB,OAAO,OAAO,CAAC,cAAc,EAAE,CAAC;IAClC,CAAC;CACF"}

package/dist/esm/encodingMethods/bytewords.d.ts

@@ -0,0 +1,27 @@
+export declare enum STYLES {
+    STANDARD = "standard",
+    URI = "uri",
+    MINIMAL = "minimal"
+}
+/**
+ * Decode a string of bytewords into a hex string.
+ * @param string string of Bytewords
+ * @param style style of Bytewords
+ * @param includeChecksum whether to include checksum in the decoding.
+ * @returns hex string
+ */
+export declare const decode: (string: string, style?: STYLES, includeChecksum?: boolean) => string;
+/**
+ * Encodes a string (hex representation of a buffer) into bytewords.
+ * @param string string to encode.
+ * @param style style to use for the encoding.
+ * @param includeChecksum whether to include checksum in the encoding.
+ * @returns the byteword encoded string
+ */
+export declare const encode: (string: string, style?: STYLES, includeChecksum?: boolean) => string;
+declare const _default: {
+    decode: (string: string, style?: STYLES, includeChecksum?: boolean) => string;
+    encode: (string: string, style?: STYLES, includeChecksum?: boolean) => string;
+    STYLES: typeof STYLES;
+};
+export default _default;

package/dist/esm/encodingMethods/bytewords.js

@@ -0,0 +1,147 @@
+import { assert, getCRCHex, partition, split } from "../helpers/utils.js";
+import { uint8ArrayToHex, hexToUint8Array } from "../helpers/uintArrayHelper.js";
+const bytewords = "ableacidalsoapexaquaarchatomauntawayaxisbackbaldbarnbeltbetabiasbluebodybragbrewbulbbuzzcalmcashcatschefcityclawcodecolacookcostcruxcurlcuspcyandarkdatadaysdelidicedietdoordowndrawdropdrumdulldutyeacheasyechoedgeepicevenexamexiteyesfactfairfernfigsfilmfishfizzflapflewfluxfoxyfreefrogfuelfundgalagamegeargemsgiftgirlglowgoodgraygrimgurugushgyrohalfhanghardhawkheathelphighhillholyhopehornhutsicedideaidleinchinkyintoirisironitemjadejazzjoinjoltjowljudojugsjumpjunkjurykeepkenokeptkeyskickkilnkingkitekiwiknoblamblavalazyleaflegsliarlimplionlistlogoloudloveluaulucklungmainmanymathmazememomenumeowmildmintmissmonknailnavyneednewsnextnoonnotenumbobeyoboeomitonyxopenovalowlspaidpartpeckplaypluspoempoolposepuffpumapurrquadquizraceramprealredorichroadrockroofrubyruinrunsrustsafesagascarsetssilkskewslotsoapsolosongstubsurfswantacotasktaxitenttiedtimetinytoiltombtoystriptunatwinuglyundouniturgeuservastveryvetovialvibeviewvisavoidvowswallwandwarmwaspwavewaxywebswhatwhenwhizwolfworkyankyawnyellyogayurtzapszerozestzinczonezoom";
+let bytewordsLookUpTable = [];
+const BYTEWORDS_NUM = 256;
+const BYTEWORD_LENGTH = 4;
+const MINIMAL_BYTEWORD_LENGTH = 2;
+export var STYLES;
+(function (STYLES) {
+    STYLES["STANDARD"] = "standard";
+    STYLES["URI"] = "uri";
+    STYLES["MINIMAL"] = "minimal";
+})(STYLES || (STYLES = {}));
+const getWord = (index) => {
+    return bytewords.slice(index * BYTEWORD_LENGTH, index * BYTEWORD_LENGTH + BYTEWORD_LENGTH);
+};
+const getMinimalWord = (index) => {
+    const byteword = getWord(index);
+    return `${byteword[0]}${byteword[BYTEWORD_LENGTH - 1]}`;
+};
+const addCRC = (string) => {
+    const crc = getCRCHex(hexToUint8Array(string));
+    return `${string}${crc}`;
+};
+const encodeWithSeparator = (word, separator, includeChecksum) => {
+    const crcAppendedWord = includeChecksum ? addCRC(word) : word;
+    const crcWordArray = hexToUint8Array(crcAppendedWord);
+    const result = crcWordArray.reduce((result, w) => [...result, getWord(w)], []);
+    return result.join(separator);
+};
+const encodeMinimal = (word, includeChecksum) => {
+    const crcAppendedWord = includeChecksum ? addCRC(word) : word;
+    const crcWordArray = hexToUint8Array(crcAppendedWord);
+    const result = crcWordArray.reduce((result, w) => result + getMinimalWord(w), "");
+    return result;
+};
+const decodeWord = (word, wordLength) => {
+    assert(word.length === wordLength, "Invalid Bytewords: word.length does not match wordLength provided");
+    const dim = 26;
+    // Since the first and last letters of each Byteword are unique,
+    // we can use them as indexes into a two-dimensional lookup table.
+    // This table is generated lazily.
+    if (bytewordsLookUpTable.length === 0) {
+        const array_len = dim * dim;
+        bytewordsLookUpTable = [...new Array(array_len)].map(() => -1);
+        for (let i = 0; i < BYTEWORDS_NUM; i++) {
+            const byteword = getWord(i);
+            let x = byteword[0].charCodeAt(0) - "a".charCodeAt(0);
+            let y = byteword[3].charCodeAt(0) - "a".charCodeAt(0);
+            let offset = y * dim + x;
+            bytewordsLookUpTable[offset] = i;
+        }
+    }
+    // If the coordinates generated by the first and last letters are out of bounds,
+    // or the lookup table contains -1 at the coordinates, then the word is not valid.
+    let x = word[0].toLowerCase().charCodeAt(0) - "a".charCodeAt(0);
+    let y = word[wordLength == 4 ? 3 : 1].toLowerCase().charCodeAt(0) -
+        "a".charCodeAt(0);
+    assert(0 <= x && x < dim && 0 <= y && y < dim, "Invalid Bytewords: invalid word");
+    let offset = y * dim + x;
+    let value = bytewordsLookUpTable[offset];
+    assert(value !== -1, "Invalid Bytewords: value not in lookup table");
+    // If we're decoding a full four-letter word, verify that the two middle letters are correct.
+    if (wordLength == BYTEWORD_LENGTH) {
+        const byteword = getWord(value);
+        let c1 = word[1].toLowerCase();
+        let c2 = word[2].toLowerCase();
+        assert(c1 === byteword[1] && c2 === byteword[2], "Invalid Bytewords: invalid middle letters of word");
+    }
+    // Successful decode.
+    return value.toString(16).padStart(2, "0");
+};
+/**
+ * Decode a string of Bytewords into a hex string.
+ * @param string string of Bytewords. e.g. "lpamchcfatttcyclehgsdphdhgehfghkkkdl..."
+ * @param separator e.g. " " or "-" or "" or any other separator
+ * @param wordLength e.g. 4 or 2 or any other length
+ * @param includeChecksum whether to include checksum in the decoding.
+ * @returns hex string
+ */
+const _decode = (string, separator, wordLength, includeChecksum) => {
+    // Split the string into words. e.g. ["lp", "am", "ch", "cf", "at", "tt", "cy", "cl", "eh", "gs", "dp", "hd", "hg", "eh", "fg", "hk", "kk", "dl", ...]
+    const words = wordLength == BYTEWORD_LENGTH
+        ? string.split(separator)
+        : partition(string, 2);
+    // Decode each word. e.g. ["85", "06", "17", "19", "07", "d1", "1a", "21", "31", "4c", "2d", "58", "57", "31", "46", "59", "79", "2f", ...]
+    const decodedWords = words.map((word) => decodeWord(word, wordLength));
+    // e.g. "8506171907d11a21314c2d5857314659792f..."
+    const decodedString = decodedWords.join("");
+    if (includeChecksum) {
+        // 4 bytes for checksum, at least 1 byte for body
+        assert(decodedString.length >= 5, "Invalid Bytewords: invalid decoded string length");
+        // decoded string consists of `body` and `checksum`
+        const decodedArray = hexToUint8Array(decodedString);
+        const [body, bodyChecksum] = split(decodedArray, 4);
+        const checksum = getCRCHex(body); // convert to hex
+        assert(checksum === uint8ArrayToHex(bodyChecksum), "Invalid Checksum");
+        return uint8ArrayToHex(body);
+    }
+    else {
+        return decodedString;
+    }
+};
+/**
+ * Decode a string of bytewords into a hex string.
+ * @param string string of Bytewords
+ * @param style style of Bytewords
+ * @param includeChecksum whether to include checksum in the decoding.
+ * @returns hex string
+ */
+export const decode = (string, style = STYLES.MINIMAL, includeChecksum = true) => {
+    switch (style) {
+        case STYLES.STANDARD:
+            return _decode(string, " ", BYTEWORD_LENGTH, includeChecksum);
+        case STYLES.URI:
+            return _decode(string, "-", BYTEWORD_LENGTH, includeChecksum);
+        case STYLES.MINIMAL:
+            return _decode(string, "", MINIMAL_BYTEWORD_LENGTH, includeChecksum);
+        default:
+            throw new Error(`Invalid style ${style}`);
+    }
+};
+/**
+ * Encodes a string (hex representation of a buffer) into bytewords.
+ * @param string string to encode.
+ * @param style style to use for the encoding.
+ * @param includeChecksum whether to include checksum in the encoding.
+ * @returns the byteword encoded string
+ */
+export const encode = (string, style = STYLES.MINIMAL, includeChecksum = true) => {
+    switch (style) {
+        case STYLES.STANDARD:
+            return encodeWithSeparator(string, " ", includeChecksum);
+        case STYLES.URI:
+            return encodeWithSeparator(string, "-", includeChecksum);
+        case STYLES.MINIMAL:
+            return encodeMinimal(string, includeChecksum);
+        default:
+            throw new Error(`Invalid style ${style}`);
+    }
+};
+export default {
+    decode,
+    encode,
+    STYLES,
+};
+//# sourceMappingURL=bytewords.js.map

package/dist/esm/encodingMethods/bytewords.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytewords.js","sourceRoot":"","sources":["../../../src/encodingMethods/bytewords.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAEjF,MAAM,SAAS,GACb,kgCAAkgC,CAAC;AACrgC,IAAI,oBAAoB,GAAa,EAAE,CAAC;AACxC,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,CAAC,CAAC;AAC1B,MAAM,uBAAuB,GAAG,CAAC,CAAC;AAElC,MAAM,CAAN,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,+BAAqB,CAAA;IACrB,qBAAW,CAAA;IACX,6BAAmB,CAAA;AACrB,CAAC,EAJW,MAAM,KAAN,MAAM,QAIjB;AAED,MAAM,OAAO,GAAG,CAAC,KAAa,EAAU,EAAE;IACxC,OAAO,SAAS,CAAC,KAAK,CACpB,KAAK,GAAG,eAAe,EACvB,KAAK,GAAG,eAAe,GAAG,eAAe,CAC1C,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,KAAa,EAAU,EAAE;IAC/C,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAEhC,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,eAAe,GAAG,CAAC,CAAC,EAAE,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,MAAc,EAAU,EAAE;IACxC,MAAM,GAAG,GAAG,SAAS,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC;IAE/C,OAAO,GAAG,MAAM,GAAG,GAAG,EAAE,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,IAAY,EAAE,SAAiB,EAAE,eAAwB,EAAU,EAAE;IAChG,MAAM,eAAe,GAAG,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC9D,MAAM,YAAY,GAAG,eAAe,CAAC,eAAe,CAAC,CAAC;IACtD,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAChC,CAAC,MAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,EAChD,EAAE,CACH,CAAC;IAEF,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AAChC,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,IAAY,EAAE,eAAwB,EAAU,EAAE;IACvE,MAAM,eAAe,GAAG,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC9D,MAAM,YAAY,GAAG,eAAe,CAAC,eAAe,CAAC,CAAC;IACtD,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAChC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC,EACzC,EAAE,CACH,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,UAAkB,EAAU,EAAE;IAC9D,MAAM,CACJ,IAAI,CAAC,MAAM,KAAK,UAAU,EAC1B,mEAAmE,CACpE,CAAC;IAEF,MAAM,GAAG,GAAG,EAAE,CAAC;IAEf,gEAAgE;IAChE,kEAAkE;IAClE,kCAAkC;IAClC,IAAI,oBAAoB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtC,MAAM,SAAS,GAAG,GAAG,GAAG,GAAG,CAAC;QAC5B,oBAAoB,GAAG,CAAC,GAAG,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YAC5B,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACtD,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACtD,IAAI,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC;YACzB,oBAAoB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAED,gFAAgF;IAChF,kFAAkF;IAClF,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAChE,IAAI,CAAC,GACH,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;QACzD,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAEpB,MAAM,CACJ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,EACtC,iCAAiC,CAClC,CAAC;IAEF,IAAI,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC;IACzB,IAAI,KAAK,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAEzC,MAAM,CAAC,KAAK,KAAK,CAAC,CAAC,EAAE,8CAA8C,CAAC,CAAC;IAErE,6FAA6F;IAC7F,IAAI,UAAU,IAAI,eAAe,EAAE,CAAC;QAClC,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QAC/B,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QAE/B,MAAM,CACJ,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,EACxC,mDAAmD,CACpD,CAAC;IACJ,CAAC;IAED,qBAAqB;IACrB,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAC7C,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,OAAO,GAAG,CACd,MAAc,EACd,SAAiB,EACjB,UAAkB,EAClB,eAAwB,EAChB,EAAE;IACV,sJAAsJ;IACtJ,MAAM,KAAK,GACT,UAAU,IAAI,eAAe;QAC3B,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;QACzB,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE3B,2IAA2I;IAC3I,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE,CAC9C,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAC7B,CAAC;IAEF,iDAAiD;IACjD,MAAM,aAAa,GAAG,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAE5C,IAAI,eAAe,EAAE,CAAC;QACpB,iDAAiD;QACjD,MAAM,CACJ,aAAa,CAAC,MAAM,IAAI,CAAC,EACzB,kDAAkD,CACnD,CAAC;QAEF,mDAAmD;QACnD,MAAM,YAAY,GAAG,eAAe,CAAC,aAAa,CAAC,CAAC;QACpD,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;QACpD,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB;QAEnD,MAAM,CAAC,QAAQ,KAAK,eAAe,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAC,CAAC;QAEvE,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;SAAM,CAAC;QACN,OAAO,aAAa,CAAC;IACvB,CAAC;AACH,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CACpB,MAAc,EACd,QAAgB,MAAM,CAAC,OAAO,EAC9B,kBAA2B,IAAI,EACvB,EAAE;IACV,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,MAAM,CAAC,QAAQ;YAClB,OAAO,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,eAAe,EAAE,eAAe,CAAC,CAAC;QAChE,KAAK,MAAM,CAAC,GAAG;YACb,OAAO,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,eAAe,EAAE,eAAe,CAAC,CAAC;QAChE,KAAK,MAAM,CAAC,OAAO;YACjB,OAAO,OAAO,CAAC,MAAM,EAAE,EAAE,EAAE,uBAAuB,EAAE,eAAe,CAAC,CAAC;QACvE;YACE,MAAM,IAAI,KAAK,CAAC,iBAAiB,KAAK,EAAE,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CACpB,MAAc,EACd,QAAgB,MAAM,CAAC,OAAO,EAC9B,kBAA2B,IAAI,EACvB,EAAE;IACV,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,MAAM,CAAC,QAAQ;YAClB,OAAO,mBAAmB,CAAC,MAAM,EAAE,GAAG,EAAE,eAAe,CAAC,CAAC;QAC3D,KAAK,MAAM,CAAC,GAAG;YACb,OAAO,mBAAmB,CAAC,MAAM,EAAE,GAAG,EAAE,eAAe,CAAC,CAAC;QAC3D,KAAK,MAAM,CAAC,OAAO;YACjB,OAAO,aAAa,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QAChD;YACE,MAAM,IAAI,KAAK,CAAC,iBAAiB,KAAK,EAAE,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC,CAAC;AAEF,eAAe;IACb,MAAM;IACN,MAAM;IACN,MAAM;CACP,CAAC"}

package/dist/esm/encodingMethods/index.d.ts

@@ -0,0 +1,19 @@
+import { BytewordEncoding } from "./BytewordEncoding.js";
+import { CborEncoding } from "./CborEncoding.js";
+import { HexEncoding } from "./HexEncoding.js";
+import { EncodingPipeline } from "./pipeline.js";
+/**
+ * Pipeline that encodes registry registryItem | any -> cbor -> hex -> bytewords
+ *
+ * Uses default encoding options for each encoding method
+ * 1. Cbor: CBOR2 library
+ * 2. Hex: Uint8Array -> hex string
+ * 3. Bytewords: Uint8Array -> bytewords string with checksum and minimal style
+ *
+ */
+export declare const defaultEncoders: {
+    cbor: CborEncoding<import("../index.js").RegistryItemBase>;
+    hex: HexEncoding;
+    bytewords: BytewordEncoding;
+};
+export declare const dataPipeline: EncodingPipeline<any, string>;

package/dist/esm/encodingMethods/index.js

@@ -0,0 +1,24 @@
+import { BytewordEncoding } from "./BytewordEncoding.js";
+import { CborEncoding } from "./CborEncoding.js";
+import { HexEncoding } from "./HexEncoding.js";
+import { EncodingPipeline } from "./pipeline.js";
+/**
+ * Pipeline that encodes registry registryItem | any -> cbor -> hex -> bytewords
+ *
+ * Uses default encoding options for each encoding method
+ * 1. Cbor: CBOR2 library
+ * 2. Hex: Uint8Array -> hex string
+ * 3. Bytewords: Uint8Array -> bytewords string with checksum and minimal style
+ *
+ */
+export const defaultEncoders = {
+    cbor: new CborEncoding(),
+    hex: new HexEncoding(),
+    bytewords: new BytewordEncoding(),
+};
+export const dataPipeline = new EncodingPipeline([
+    defaultEncoders.cbor,
+    defaultEncoders.hex,
+    defaultEncoders.bytewords,
+]);
+//# sourceMappingURL=index.js.map

package/dist/esm/encodingMethods/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/encodingMethods/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEjD;;;;;;;;GAQG;AAEH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE,IAAI,YAAY,EAAE;IACxB,GAAG,EAAE,IAAI,WAAW,EAAE;IACtB,SAAS,EAAE,IAAI,gBAAgB,EAAE;CAClC,CAAA;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,gBAAgB,CAAc;IAC5D,eAAe,CAAC,IAAI;IACpB,eAAe,CAAC,GAAG;IACnB,eAAe,CAAC,SAAS;CAC1B,CAAC,CAAC"}

package/dist/esm/encodingMethods/pipeline.d.ts

@@ -0,0 +1,19 @@
+import { EncodingMethodName } from "../enums/EncodingMethodName.js";
+import { IEncodingMethod } from "../interfaces/IEncodingMethod.js";
+interface pipelineConfig {
+    from?: EncodingMethodName;
+    until?: EncodingMethodName;
+    [key: string]: any;
+}
+export declare class EncodingPipeline<T, U> implements IEncodingMethod<T, U> {
+    private _name;
+    private _encodingMethods;
+    constructor(encodingMethods: IEncodingMethod<any, any>[]);
+    get name(): EncodingMethodName;
+    get encodingMethods(): IEncodingMethod<any, any>[];
+    get decodingMethods(): IEncodingMethod<any, any>[];
+    encode<O = U>(payload: T, config?: pipelineConfig): O;
+    decode<O = T>(payload: U, config?: pipelineConfig): O;
+    getMethod(methodName: EncodingMethodName): IEncodingMethod<any, any>;
+}
+export {};

package/dist/esm/encodingMethods/pipeline.js

@@ -0,0 +1,76 @@
+import { EncodingMethodName } from "../enums/EncodingMethodName.js";
+export class EncodingPipeline {
+    _name = EncodingMethodName.pipe;
+    _encodingMethods;
+    constructor(encodingMethods) {
+        this._encodingMethods = encodingMethods;
+    }
+    get name() {
+        return this._name;
+    }
+    get encodingMethods() {
+        return this._encodingMethods;
+    }
+    get decodingMethods() {
+        return this._encodingMethods.slice().reverse();
+    }
+    // TODO: change until to "to"
+    encode(payload, config = { from: undefined, until: undefined }) {
+        let encodedValue = payload;
+        let fromIndex = 0;
+        let untilIndex = this.encodingMethods.length;
+        const { from, until, ...rest } = config;
+        // Find the index of the specified start and until encoding methods
+        if (from) {
+            fromIndex = this.encodingMethods.findIndex((method) => method.name === from);
+            if (fromIndex === -1) {
+                throw new Error(`Encoding method ${from} not found`);
+            }
+        }
+        if (until) {
+            untilIndex = this.encodingMethods.findIndex((method) => method.name === until);
+            if (untilIndex === -1) {
+                throw new Error(`Encoding method ${until} not found`);
+            }
+        }
+        if (fromIndex > untilIndex) {
+            throw new Error("Invalid encoding method range");
+        }
+        // Apply each encoding method in sequence until the specified encoding method or the end
+        for (let i = fromIndex; i < untilIndex; i++) {
+            encodedValue = this.encodingMethods[i].encode(encodedValue, rest);
+        }
+        return encodedValue;
+    }
+    decode(payload, config = { from: undefined, until: undefined }) {
+        let decodedValue = payload;
+        let fromIndex = 0;
+        let untilIndex = this.decodingMethods.length;
+        const { from, until, ...rest } = config;
+        // Find the index of the specified start and until encoding methods
+        if (from) {
+            fromIndex = this.decodingMethods.findIndex((method) => method.name === from);
+            if (fromIndex === -1) {
+                throw new Error(`Encoding method ${from} not found`);
+            }
+        }
+        if (until) {
+            untilIndex = this.decodingMethods.findIndex((method) => method.name === until);
+            if (untilIndex === -1) {
+                throw new Error(`Encoding method ${until} not found`);
+            }
+        }
+        if (fromIndex > untilIndex) {
+            throw new Error("Invalid encoding method range");
+        }
+        // Apply each encoding method in sequence until the specified encoding method or the end
+        for (let i = fromIndex; i < untilIndex; i++) {
+            decodedValue = this.decodingMethods[i].decode(decodedValue, rest);
+        }
+        return decodedValue;
+    }
+    getMethod(methodName) {
+        return this.encodingMethods.find((method) => method.name === methodName);
+    }
+}
+//# sourceMappingURL=pipeline.js.map

package/dist/esm/encodingMethods/pipeline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../../../src/encodingMethods/pipeline.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AASpE,MAAM,OAAO,gBAAgB;IACnB,KAAK,GAAuB,kBAAkB,CAAC,IAAI,CAAC;IACpD,gBAAgB,CAA8B;IAEtD,YAAY,eAA4C;QACtD,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;IAC1C,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,CAAC;IACjD,CAAC;IAGD,6BAA6B;IAC7B,MAAM,CAAQ,OAAU,EAAE,SAAyB,EAAC,IAAI,EAAC,SAAS,EAAE,KAAK,EAAC,SAAS,EAAC;QAClF,IAAI,YAAY,GAAQ,OAAO,CAAC;QAChC,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,IAAI,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;QAE7C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAExC,mEAAmE;QACnE,IAAG,IAAI,EAAE,CAAC;YACR,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;YAC7E,IAAG,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC;gBACpB,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,YAAY,CAAC,CAAC;YACvD,CAAC;QACH,CAAC;QAED,IAAG,KAAK,EAAE,CAAC;YACT,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC;YAC/E,IAAG,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;gBACrB,MAAM,IAAI,KAAK,CAAC,mBAAmB,KAAK,YAAY,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QAED,IAAG,SAAS,GAAG,UAAU,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QAED,wFAAwF;QACxF,KAAK,IAAI,CAAC,GAAG,SAAS,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5C,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QACpE,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,MAAM,CAAQ,OAAU,EAAE,SAAyB,EAAC,IAAI,EAAC,SAAS,EAAE,KAAK,EAAC,SAAS,EAAC;QAClF,IAAI,YAAY,GAAQ,OAAO,CAAC;QAChC,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,IAAI,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;QAE7C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAExC,mEAAmE;QACnE,IAAG,IAAI,EAAE,CAAC;YACR,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;YAC7E,IAAG,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC;gBACpB,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,YAAY,CAAC,CAAC;YACvD,CAAC;QACH,CAAC;QAED,IAAG,KAAK,EAAE,CAAC;YACT,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC;YAC/E,IAAG,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;gBACrB,MAAM,IAAI,KAAK,CAAC,mBAAmB,KAAK,YAAY,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QAED,IAAG,SAAS,GAAG,UAAU,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QAED,wFAAwF;QACxF,KAAK,IAAI,CAAC,GAAG,SAAS,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5C,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QACpE,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,SAAS,CAAC,UAA8B;QACtC,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IAC3E,CAAC;CAEF"}

package/dist/esm/enums/EncodingMethodName.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Defaultly used encoding methods.
+ */
+export declare enum EncodingMethodName {
+    bytewords = "bytewords",
+    cbor = "cbor",
+    hex = "hex",
+    pipe = "pipe",
+    ur = "ur"
+}

package/dist/esm/enums/EncodingMethodName.js

@@ -0,0 +1,12 @@
+/**
+ * Defaultly used encoding methods.
+ */
+export var EncodingMethodName;
+(function (EncodingMethodName) {
+    EncodingMethodName["bytewords"] = "bytewords";
+    EncodingMethodName["cbor"] = "cbor";
+    EncodingMethodName["hex"] = "hex";
+    EncodingMethodName["pipe"] = "pipe";
+    EncodingMethodName["ur"] = "ur";
+})(EncodingMethodName || (EncodingMethodName = {}));
+//# sourceMappingURL=EncodingMethodName.js.map

package/dist/esm/enums/EncodingMethodName.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EncodingMethodName.js","sourceRoot":"","sources":["../../../src/enums/EncodingMethodName.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,mCAAa,CAAA;IACb,iCAAW,CAAA;IACX,mCAAa,CAAA;IACb,+BAAS,CAAA;AACX,CAAC,EANW,kBAAkB,KAAlB,kBAAkB,QAM7B"}