@twin.org/core 0.0.2-next.9 → 0.0.3-next.2

package/dist/es/utils/converter.js

@@ -0,0 +1,256 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/* eslint-disable no-bitwise */
+import { Base58 } from "../encoding/base58.js";
+import { Base64 } from "../encoding/base64.js";
+import { Base64Url } from "../encoding/base64Url.js";
+import { HexHelper } from "../helpers/hexHelper.js";
+/**
+ * Convert arrays to and from different formats.
+ */
+export class Converter {
+    /**
+     * Lookup table for encoding.
+     * @internal
+     */
+    static _ENCODE_LOOKUP;
+    /**
+     * Lookup table for decoding.
+     * @internal
+     */
+    static _DECODE_LOOKUP;
+    /**
+     * Encode a raw array to UTF8 string.
+     * @param array The bytes to encode.
+     * @param startIndex The index to start in the bytes.
+     * @param length The length of bytes to read.
+     * @returns The array formatted as UTF8.
+     */
+    static bytesToUtf8(array, startIndex, length) {
+        const start = startIndex ?? 0;
+        const len = length ?? array.length;
+        let str = "";
+        for (let i = start; i < start + len; i++) {
+            const value = array[i];
+            if (value < 0x80) {
+                str += String.fromCharCode(value);
+            }
+            else if (value > 0xbf && value < 0xe0) {
+                str += String.fromCharCode(((value & 0x1f) << 6) | (array[i + 1] & 0x3f));
+                i += 1;
+            }
+            else if (value > 0xdf && value < 0xf0) {
+                str += String.fromCharCode(((value & 0x0f) << 12) | ((array[i + 1] & 0x3f) << 6) | (array[i + 2] & 0x3f));
+                i += 2;
+            }
+            else {
+                // surrogate pair
+                const charCode = (((value & 0x07) << 18) |
+                    ((array[i + 1] & 0x3f) << 12) |
+                    ((array[i + 2] & 0x3f) << 6) |
+                    (array[i + 3] & 0x3f)) -
+                    0x010000;
+                str += String.fromCharCode((charCode >> 10) | 0xd800, (charCode & 0x03ff) | 0xdc00);
+                i += 3;
+            }
+        }
+        return str;
+    }
+    /**
+     * Convert a UTF8 string to raw array.
+     * @param utf8 The text to decode.
+     * @returns The array.
+     */
+    static utf8ToBytes(utf8) {
+        const bytes = [];
+        for (let i = 0; i < utf8.length; i++) {
+            let charCode = utf8.charCodeAt(i);
+            if (charCode < 0x80) {
+                bytes.push(charCode);
+            }
+            else if (charCode < 0x800) {
+                bytes.push(0xc0 | (charCode >> 6), 0x80 | (charCode & 0x3f));
+            }
+            else if (charCode < 0xd800 || charCode >= 0xe000) {
+                bytes.push(0xe0 | (charCode >> 12), 0x80 | ((charCode >> 6) & 0x3f), 0x80 | (charCode & 0x3f));
+            }
+            else {
+                // surrogate pair
+                i++;
+                // UTF-16 encodes 0x10000-0x10FFFF by
+                // subtracting 0x10000 and splitting the
+                // 20 bits of 0x0-0xFFFFF into two halves
+                charCode = 0x10000 + (((charCode & 0x3ff) << 10) | (utf8.charCodeAt(i) & 0x3ff));
+                bytes.push(0xf0 | (charCode >> 18), 0x80 | ((charCode >> 12) & 0x3f), 0x80 | ((charCode >> 6) & 0x3f), 0x80 | (charCode & 0x3f));
+            }
+        }
+        return Uint8Array.from(bytes);
+    }
+    /**
+     * Encode a raw array to hex string.
+     * @param array The bytes to encode.
+     * @param includePrefix Include the 0x prefix on the returned hex.
+     * @param startIndex The index to start in the bytes.
+     * @param length The length of bytes to read.
+     * @param reverse Reverse the combine direction.
+     * @returns The array formatted as hex.
+     */
+    static bytesToHex(array, includePrefix = false, startIndex, length, reverse) {
+        let hex = "";
+        Converter.buildHexLookups();
+        if (Converter._ENCODE_LOOKUP) {
+            const len = length ?? array.length;
+            const start = startIndex ?? 0;
+            if (reverse) {
+                for (let i = 0; i < len; i++) {
+                    hex = Converter._ENCODE_LOOKUP[array[start + i]] + hex;
+                }
+            }
+            else {
+                for (let i = 0; i < len; i++) {
+                    hex += Converter._ENCODE_LOOKUP[array[start + i]];
+                }
+            }
+        }
+        return includePrefix ? HexHelper.addPrefix(hex) : hex;
+    }
+    /**
+     * Decode a hex string to raw array.
+     * @param hex The hex to decode.
+     * @param reverse Store the characters in reverse.
+     * @returns The array.
+     */
+    static hexToBytes(hex, reverse) {
+        const strippedHex = HexHelper.stripPrefix(hex);
+        const sizeof = strippedHex.length >> 1;
+        const length = sizeof << 1;
+        const array = new Uint8Array(sizeof);
+        Converter.buildHexLookups();
+        if (Converter._DECODE_LOOKUP) {
+            let i = 0;
+            let n = 0;
+            while (i < length) {
+                array[n++] =
+                    (Converter._DECODE_LOOKUP[strippedHex.charCodeAt(i++)] << 4) |
+                        Converter._DECODE_LOOKUP[strippedHex.charCodeAt(i++)];
+            }
+            if (reverse) {
+                array.reverse();
+            }
+        }
+        return array;
+    }
+    /**
+     * Convert the UTF8 to hex.
+     * @param utf8 The text to convert.
+     * @param includePrefix Include the 0x prefix on the returned hex.
+     * @returns The hex version of the bytes.
+     */
+    static utf8ToHex(utf8, includePrefix = false) {
+        const hex = Converter.bytesToHex(Converter.utf8ToBytes(utf8));
+        return includePrefix ? HexHelper.addPrefix(hex) : hex;
+    }
+    /**
+     * Convert the hex text to text.
+     * @param hex The hex to convert.
+     * @returns The UTF8 version of the bytes.
+     */
+    static hexToUtf8(hex) {
+        return Converter.bytesToUtf8(Converter.hexToBytes(HexHelper.stripPrefix(hex)));
+    }
+    /**
+     * Convert bytes to binary string.
+     * @param bytes The bytes to convert.
+     * @returns A binary string of the bytes.
+     */
+    static bytesToBinary(bytes) {
+        const b = [];
+        for (let i = 0; i < bytes.length; i++) {
+            b.push(bytes[i].toString(2).padStart(8, "0"));
+        }
+        return b.join("");
+    }
+    /**
+     * Convert a binary string to bytes.
+     * @param binary The binary string.
+     * @returns The bytes.
+     */
+    static binaryToBytes(binary) {
+        const bytes = new Uint8Array(Math.ceil(binary.length / 8));
+        for (let i = 0; i < bytes.length; i++) {
+            bytes[i] = Number.parseInt(binary.slice(i * 8, (i + 1) * 8), 2);
+        }
+        return bytes;
+    }
+    /**
+     * Convert bytes to base64 string.
+     * @param bytes The bytes to convert.
+     * @returns A base64 string of the bytes.
+     */
+    static bytesToBase64(bytes) {
+        return Base64.encode(bytes);
+    }
+    /**
+     * Convert a base64 string to bytes.
+     * @param base64 The base64 string.
+     * @returns The bytes.
+     */
+    static base64ToBytes(base64) {
+        return Base64.decode(base64);
+    }
+    /**
+     * Convert bytes to base64 url string.
+     * @param bytes The bytes to convert.
+     * @returns A base64 url string of the bytes.
+     */
+    static bytesToBase64Url(bytes) {
+        return Base64Url.encode(bytes);
+    }
+    /**
+     * Convert a base64 url string to bytes.
+     * @param base64Url The base64 url string.
+     * @returns The bytes.
+     */
+    static base64UrlToBytes(base64Url) {
+        return Base64Url.decode(base64Url);
+    }
+    /**
+     * Convert bytes to base58 string.
+     * @param bytes The bytes to convert.
+     * @returns A base58 string of the bytes.
+     */
+    static bytesToBase58(bytes) {
+        return Base58.encode(bytes);
+    }
+    /**
+     * Convert a base58 string to bytes.
+     * @param base58 The base58 string.
+     * @returns The bytes.
+     */
+    static base58ToBytes(base58) {
+        return Base58.decode(base58);
+    }
+    /**
+     * Build the static lookup tables.
+     * @internal
+     */
+    static buildHexLookups() {
+        if (!Converter._ENCODE_LOOKUP || !Converter._DECODE_LOOKUP) {
+            const alphabet = "0123456789abcdef";
+            Converter._ENCODE_LOOKUP = [];
+            Converter._DECODE_LOOKUP = [];
+            for (let i = 0; i < 256; i++) {
+                Converter._ENCODE_LOOKUP[i] = alphabet[(i >> 4) & 0xf] + alphabet[i & 0xf];
+                if (i < 16) {
+                    if (i < 10) {
+                        Converter._DECODE_LOOKUP[0x30 + i] = i;
+                    }
+                    else {
+                        Converter._DECODE_LOOKUP[0x61 - 10 + i] = i;
+                    }
+                }
+            }
+        }
+    }
+}
+//# sourceMappingURL=converter.js.map

package/dist/es/utils/converter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"converter.js","sourceRoot":"","sources":["../../../src/utils/converter.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,+BAA+B;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD;;GAEG;AACH,MAAM,OAAO,SAAS;IACrB;;;OAGG;IACK,MAAM,CAAC,cAAc,CAAuB;IAEpD;;;OAGG;IACK,MAAM,CAAC,cAAc,CAAuB;IAEpD;;;;;;OAMG;IACI,MAAM,CAAC,WAAW,CACxB,KAAwB,EACxB,UAAmB,EACnB,MAA2B;QAE3B,MAAM,KAAK,GAAG,UAAU,IAAI,CAAC,CAAC;QAC9B,MAAM,GAAG,GAAG,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;QACnC,IAAI,GAAG,GAAG,EAAE,CAAC;QAEb,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YAC1C,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAEvB,IAAI,KAAK,GAAG,IAAI,EAAE,CAAC;gBAClB,GAAG,IAAI,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACnC,CAAC;iBAAM,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,IAAI,EAAE,CAAC;gBACzC,GAAG,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;gBAC1E,CAAC,IAAI,CAAC,CAAC;YACR,CAAC;iBAAM,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,IAAI,EAAE,CAAC;gBACzC,GAAG,IAAI,MAAM,CAAC,YAAY,CACzB,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAC7E,CAAC;gBACF,CAAC,IAAI,CAAC,CAAC;YACR,CAAC;iBAAM,CAAC;gBACP,iBAAiB;gBACjB,MAAM,QAAQ,GACb,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;oBACtB,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;oBAC7B,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC5B,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;oBACvB,QAAQ,CAAC;gBAEV,GAAG,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC,QAAQ,IAAI,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,QAAQ,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC;gBACpF,CAAC,IAAI,CAAC,CAAC;YACR,CAAC;QACF,CAAC;QAED,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,WAAW,CAAC,IAAY;QACrC,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,IAAI,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YAClC,IAAI,QAAQ,GAAG,IAAI,EAAE,CAAC;gBACrB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACtB,CAAC;iBAAM,IAAI,QAAQ,GAAG,KAAK,EAAE,CAAC;gBAC7B,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,QAAQ,IAAI,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC;YAC9D,CAAC;iBAAM,IAAI,QAAQ,GAAG,MAAM,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;gBACpD,KAAK,CAAC,IAAI,CACT,IAAI,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,EACvB,IAAI,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,EAC/B,IAAI,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,CACxB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACP,iBAAiB;gBACjB,CAAC,EAAE,CAAC;gBACJ,qCAAqC;gBACrC,wCAAwC;gBACxC,yCAAyC;gBACzC,QAAQ,GAAG,OAAO,GAAG,CAAC,CAAC,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;gBACjF,KAAK,CAAC,IAAI,CACT,IAAI,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,EACvB,IAAI,GAAG,CAAC,CAAC,QAAQ,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,EAChC,IAAI,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,EAC/B,IAAI,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,CACxB,CAAC;YACH,CAAC;QACF,CAAC;QAED,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,UAAU,CACvB,KAAwB,EACxB,gBAAyB,KAAK,EAC9B,UAAmB,EACnB,MAA2B,EAC3B,OAAiB;QAEjB,IAAI,GAAG,GAAG,EAAE,CAAC;QACb,SAAS,CAAC,eAAe,EAAE,CAAC;QAC5B,IAAI,SAAS,CAAC,cAAc,EAAE,CAAC;YAC9B,MAAM,GAAG,GAAG,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;YACnC,MAAM,KAAK,GAAG,UAAU,IAAI,CAAC,CAAC;YAC9B,IAAI,OAAO,EAAE,CAAC;gBACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC9B,GAAG,GAAG,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;gBACxD,CAAC;YACF,CAAC;iBAAM,CAAC;gBACP,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC9B,GAAG,IAAI,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;gBACnD,CAAC;YACF,CAAC;QACF,CAAC;QACD,OAAO,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,GAAW,EAAE,OAAiB;QACtD,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,IAAI,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,CAAC;QAC3B,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QAErC,SAAS,CAAC,eAAe,EAAE,CAAC;QAC5B,IAAI,SAAS,CAAC,cAAc,EAAE,CAAC;YAC9B,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,OAAO,CAAC,GAAG,MAAM,EAAE,CAAC;gBACnB,KAAK,CAAC,CAAC,EAAE,CAAC;oBACT,CAAC,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;wBAC5D,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YACxD,CAAC;YAED,IAAI,OAAO,EAAE,CAAC;gBACb,KAAK,CAAC,OAAO,EAAE,CAAC;YACjB,CAAC;QACF,CAAC;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,SAAS,CAAC,IAAY,EAAE,gBAAyB,KAAK;QACnE,MAAM,GAAG,GAAG,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9D,OAAO,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,GAAW;QAClC,OAAO,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAChF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,KAAiB;QAC5C,MAAM,CAAC,GAAG,EAAE,CAAC;QACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,MAAc;QACzC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QAC3D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACjE,CAAC;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,KAAiB;QAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,MAAc;QACzC,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,KAAiB;QAC/C,OAAO,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,SAAiB;QAC/C,OAAO,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,KAAiB;QAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,MAAc;QACzC,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,eAAe;QAC7B,IAAI,CAAC,SAAS,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC;YAC5D,MAAM,QAAQ,GAAG,kBAAkB,CAAC;YACpC,SAAS,CAAC,cAAc,GAAG,EAAE,CAAC;YAC9B,SAAS,CAAC,cAAc,GAAG,EAAE,CAAC;YAE9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC9B,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;gBAC3E,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;oBACZ,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;wBACZ,SAAS,CAAC,cAAc,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;oBACxC,CAAC;yBAAM,CAAC;wBACP,SAAS,CAAC,cAAc,CAAC,IAAI,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;oBAC7C,CAAC;gBACF,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n/* eslint-disable no-bitwise */\nimport { Base58 } from \"../encoding/base58.js\";\nimport { Base64 } from \"../encoding/base64.js\";\nimport { Base64Url } from \"../encoding/base64Url.js\";\nimport { HexHelper } from \"../helpers/hexHelper.js\";\n\n/**\n * Convert arrays to and from different formats.\n */\nexport class Converter {\n\t/**\n\t * Lookup table for encoding.\n\t * @internal\n\t */\n\tprivate static _ENCODE_LOOKUP: string[] | undefined;\n\n\t/**\n\t * Lookup table for decoding.\n\t * @internal\n\t */\n\tprivate static _DECODE_LOOKUP: number[] | undefined;\n\n\t/**\n\t * Encode a raw array to UTF8 string.\n\t * @param array The bytes to encode.\n\t * @param startIndex The index to start in the bytes.\n\t * @param length The length of bytes to read.\n\t * @returns The array formatted as UTF8.\n\t */\n\tpublic static bytesToUtf8(\n\t\tarray: ArrayLike<number>,\n\t\tstartIndex?: number,\n\t\tlength?: number | undefined\n\t): string {\n\t\tconst start = startIndex ?? 0;\n\t\tconst len = length ?? array.length;\n\t\tlet str = \"\";\n\n\t\tfor (let i = start; i < start + len; i++) {\n\t\t\tconst value = array[i];\n\n\t\t\tif (value < 0x80) {\n\t\t\t\tstr += String.fromCharCode(value);\n\t\t\t} else if (value > 0xbf && value < 0xe0) {\n\t\t\t\tstr += String.fromCharCode(((value & 0x1f) << 6) | (array[i + 1] & 0x3f));\n\t\t\t\ti += 1;\n\t\t\t} else if (value > 0xdf && value < 0xf0) {\n\t\t\t\tstr += String.fromCharCode(\n\t\t\t\t\t((value & 0x0f) << 12) | ((array[i + 1] & 0x3f) << 6) | (array[i + 2] & 0x3f)\n\t\t\t\t);\n\t\t\t\ti += 2;\n\t\t\t} else {\n\t\t\t\t// surrogate pair\n\t\t\t\tconst charCode =\n\t\t\t\t\t(((value & 0x07) << 18) |\n\t\t\t\t\t\t((array[i + 1] & 0x3f) << 12) |\n\t\t\t\t\t\t((array[i + 2] & 0x3f) << 6) |\n\t\t\t\t\t\t(array[i + 3] & 0x3f)) -\n\t\t\t\t\t0x010000;\n\n\t\t\t\tstr += String.fromCharCode((charCode >> 10) | 0xd800, (charCode & 0x03ff) | 0xdc00);\n\t\t\t\ti += 3;\n\t\t\t}\n\t\t}\n\n\t\treturn str;\n\t}\n\n\t/**\n\t * Convert a UTF8 string to raw array.\n\t * @param utf8 The text to decode.\n\t * @returns The array.\n\t */\n\tpublic static utf8ToBytes(utf8: string): Uint8Array {\n\t\tconst bytes: number[] = [];\n\n\t\tfor (let i = 0; i < utf8.length; i++) {\n\t\t\tlet charCode = utf8.charCodeAt(i);\n\t\t\tif (charCode < 0x80) {\n\t\t\t\tbytes.push(charCode);\n\t\t\t} else if (charCode < 0x800) {\n\t\t\t\tbytes.push(0xc0 | (charCode >> 6), 0x80 | (charCode & 0x3f));\n\t\t\t} else if (charCode < 0xd800 || charCode >= 0xe000) {\n\t\t\t\tbytes.push(\n\t\t\t\t\t0xe0 | (charCode >> 12),\n\t\t\t\t\t0x80 | ((charCode >> 6) & 0x3f),\n\t\t\t\t\t0x80 | (charCode & 0x3f)\n\t\t\t\t);\n\t\t\t} else {\n\t\t\t\t// surrogate pair\n\t\t\t\ti++;\n\t\t\t\t// UTF-16 encodes 0x10000-0x10FFFF by\n\t\t\t\t// subtracting 0x10000 and splitting the\n\t\t\t\t// 20 bits of 0x0-0xFFFFF into two halves\n\t\t\t\tcharCode = 0x10000 + (((charCode & 0x3ff) << 10) | (utf8.charCodeAt(i) & 0x3ff));\n\t\t\t\tbytes.push(\n\t\t\t\t\t0xf0 | (charCode >> 18),\n\t\t\t\t\t0x80 | ((charCode >> 12) & 0x3f),\n\t\t\t\t\t0x80 | ((charCode >> 6) & 0x3f),\n\t\t\t\t\t0x80 | (charCode & 0x3f)\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\n\t\treturn Uint8Array.from(bytes);\n\t}\n\n\t/**\n\t * Encode a raw array to hex string.\n\t * @param array The bytes to encode.\n\t * @param includePrefix Include the 0x prefix on the returned hex.\n\t * @param startIndex The index to start in the bytes.\n\t * @param length The length of bytes to read.\n\t * @param reverse Reverse the combine direction.\n\t * @returns The array formatted as hex.\n\t */\n\tpublic static bytesToHex(\n\t\tarray: ArrayLike<number>,\n\t\tincludePrefix: boolean = false,\n\t\tstartIndex?: number,\n\t\tlength?: number | undefined,\n\t\treverse?: boolean\n\t): string {\n\t\tlet hex = \"\";\n\t\tConverter.buildHexLookups();\n\t\tif (Converter._ENCODE_LOOKUP) {\n\t\t\tconst len = length ?? array.length;\n\t\t\tconst start = startIndex ?? 0;\n\t\t\tif (reverse) {\n\t\t\t\tfor (let i = 0; i < len; i++) {\n\t\t\t\t\thex = Converter._ENCODE_LOOKUP[array[start + i]] + hex;\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tfor (let i = 0; i < len; i++) {\n\t\t\t\t\thex += Converter._ENCODE_LOOKUP[array[start + i]];\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn includePrefix ? HexHelper.addPrefix(hex) : hex;\n\t}\n\n\t/**\n\t * Decode a hex string to raw array.\n\t * @param hex The hex to decode.\n\t * @param reverse Store the characters in reverse.\n\t * @returns The array.\n\t */\n\tpublic static hexToBytes(hex: string, reverse?: boolean): Uint8Array {\n\t\tconst strippedHex = HexHelper.stripPrefix(hex);\n\t\tconst sizeof = strippedHex.length >> 1;\n\t\tconst length = sizeof << 1;\n\t\tconst array = new Uint8Array(sizeof);\n\n\t\tConverter.buildHexLookups();\n\t\tif (Converter._DECODE_LOOKUP) {\n\t\t\tlet i = 0;\n\t\t\tlet n = 0;\n\t\t\twhile (i < length) {\n\t\t\t\tarray[n++] =\n\t\t\t\t\t(Converter._DECODE_LOOKUP[strippedHex.charCodeAt(i++)] << 4) |\n\t\t\t\t\tConverter._DECODE_LOOKUP[strippedHex.charCodeAt(i++)];\n\t\t\t}\n\n\t\t\tif (reverse) {\n\t\t\t\tarray.reverse();\n\t\t\t}\n\t\t}\n\t\treturn array;\n\t}\n\n\t/**\n\t * Convert the UTF8 to hex.\n\t * @param utf8 The text to convert.\n\t * @param includePrefix Include the 0x prefix on the returned hex.\n\t * @returns The hex version of the bytes.\n\t */\n\tpublic static utf8ToHex(utf8: string, includePrefix: boolean = false): string {\n\t\tconst hex = Converter.bytesToHex(Converter.utf8ToBytes(utf8));\n\t\treturn includePrefix ? HexHelper.addPrefix(hex) : hex;\n\t}\n\n\t/**\n\t * Convert the hex text to text.\n\t * @param hex The hex to convert.\n\t * @returns The UTF8 version of the bytes.\n\t */\n\tpublic static hexToUtf8(hex: string): string {\n\t\treturn Converter.bytesToUtf8(Converter.hexToBytes(HexHelper.stripPrefix(hex)));\n\t}\n\n\t/**\n\t * Convert bytes to binary string.\n\t * @param bytes The bytes to convert.\n\t * @returns A binary string of the bytes.\n\t */\n\tpublic static bytesToBinary(bytes: Uint8Array): string {\n\t\tconst b = [];\n\t\tfor (let i = 0; i < bytes.length; i++) {\n\t\t\tb.push(bytes[i].toString(2).padStart(8, \"0\"));\n\t\t}\n\t\treturn b.join(\"\");\n\t}\n\n\t/**\n\t * Convert a binary string to bytes.\n\t * @param binary The binary string.\n\t * @returns The bytes.\n\t */\n\tpublic static binaryToBytes(binary: string): Uint8Array {\n\t\tconst bytes = new Uint8Array(Math.ceil(binary.length / 8));\n\t\tfor (let i = 0; i < bytes.length; i++) {\n\t\t\tbytes[i] = Number.parseInt(binary.slice(i * 8, (i + 1) * 8), 2);\n\t\t}\n\t\treturn bytes;\n\t}\n\n\t/**\n\t * Convert bytes to base64 string.\n\t * @param bytes The bytes to convert.\n\t * @returns A base64 string of the bytes.\n\t */\n\tpublic static bytesToBase64(bytes: Uint8Array): string {\n\t\treturn Base64.encode(bytes);\n\t}\n\n\t/**\n\t * Convert a base64 string to bytes.\n\t * @param base64 The base64 string.\n\t * @returns The bytes.\n\t */\n\tpublic static base64ToBytes(base64: string): Uint8Array {\n\t\treturn Base64.decode(base64);\n\t}\n\n\t/**\n\t * Convert bytes to base64 url string.\n\t * @param bytes The bytes to convert.\n\t * @returns A base64 url string of the bytes.\n\t */\n\tpublic static bytesToBase64Url(bytes: Uint8Array): string {\n\t\treturn Base64Url.encode(bytes);\n\t}\n\n\t/**\n\t * Convert a base64 url string to bytes.\n\t * @param base64Url The base64 url string.\n\t * @returns The bytes.\n\t */\n\tpublic static base64UrlToBytes(base64Url: string): Uint8Array {\n\t\treturn Base64Url.decode(base64Url);\n\t}\n\n\t/**\n\t * Convert bytes to base58 string.\n\t * @param bytes The bytes to convert.\n\t * @returns A base58 string of the bytes.\n\t */\n\tpublic static bytesToBase58(bytes: Uint8Array): string {\n\t\treturn Base58.encode(bytes);\n\t}\n\n\t/**\n\t * Convert a base58 string to bytes.\n\t * @param base58 The base58 string.\n\t * @returns The bytes.\n\t */\n\tpublic static base58ToBytes(base58: string): Uint8Array {\n\t\treturn Base58.decode(base58);\n\t}\n\n\t/**\n\t * Build the static lookup tables.\n\t * @internal\n\t */\n\tprivate static buildHexLookups(): void {\n\t\tif (!Converter._ENCODE_LOOKUP || !Converter._DECODE_LOOKUP) {\n\t\t\tconst alphabet = \"0123456789abcdef\";\n\t\t\tConverter._ENCODE_LOOKUP = [];\n\t\t\tConverter._DECODE_LOOKUP = [];\n\n\t\t\tfor (let i = 0; i < 256; i++) {\n\t\t\t\tConverter._ENCODE_LOOKUP[i] = alphabet[(i >> 4) & 0xf] + alphabet[i & 0xf];\n\t\t\t\tif (i < 16) {\n\t\t\t\t\tif (i < 10) {\n\t\t\t\t\t\tConverter._DECODE_LOOKUP[0x30 + i] = i;\n\t\t\t\t\t} else {\n\t\t\t\t\t\tConverter._DECODE_LOOKUP[0x61 - 10 + i] = i;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n"]}

package/dist/es/utils/guards.js

@@ -0,0 +1,369 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Is } from "./is.js";
+import { GuardError } from "../errors/guardError.js";
+import { ArrayHelper } from "../helpers/arrayHelper.js";
+import { HexHelper } from "../helpers/hexHelper.js";
+/**
+ * Class to handle guard operations for parameters.
+ */
+export class Guards {
+    /**
+     * Is the property defined.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static defined(source, property, value) {
+        if (Is.undefined(value)) {
+            throw new GuardError(source, "guard.undefined", property, value);
+        }
+    }
+    /**
+     * Is the property a string.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static string(source, property, value) {
+        if (!Is.string(value)) {
+            throw new GuardError(source, "guard.string", property, value);
+        }
+    }
+    /**
+     * Is the property a string with a value.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static stringValue(source, property, value) {
+        if (!Is.string(value)) {
+            throw new GuardError(source, "guard.string", property, value);
+        }
+        if (value.length === 0) {
+            throw new GuardError(source, "guard.stringEmpty", property, value);
+        }
+    }
+    /**
+     * Is the property a JSON value.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static json(source, property, value) {
+        if (!Is.json(value)) {
+            throw new GuardError(source, "guard.stringJson", property, value);
+        }
+    }
+    /**
+     * Is the property a base64 string.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static stringBase64(source, property, value) {
+        if (!Is.stringBase64(value)) {
+            throw new GuardError(source, "guard.stringBase64", property, value);
+        }
+    }
+    /**
+     * Is the property a base64 url string.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static stringBase64Url(source, property, value) {
+        if (!Is.stringBase64Url(value)) {
+            throw new GuardError(source, "guard.stringBase64Url", property, value);
+        }
+    }
+    /**
+     * Is the property a base58 string.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static stringBase58(source, property, value) {
+        if (!Is.stringBase58(value)) {
+            throw new GuardError(source, "guard.stringBase58", property, value);
+        }
+    }
+    /**
+     * Is the property a string with a hex value.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param allowPrefix Allow the hex to have the 0x prefix.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static stringHex(source, property, value, allowPrefix = false) {
+        Guards.stringValue(source, property, value);
+        if (!HexHelper.isHex(value, allowPrefix)) {
+            throw new GuardError(source, "guard.stringHex", property, value);
+        }
+    }
+    /**
+     * Is the property a string with a hex value with fixed length.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param length The length of the string to match.
+     * @param allowPrefix Allow the hex to have the 0x prefix.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static stringHexLength(source, property, value, length, allowPrefix = false) {
+        Guards.stringHex(source, property, value, allowPrefix);
+        if (HexHelper.stripPrefix(value).length !== length) {
+            throw new GuardError(source, "guard.stringHexLength", property, value.length, length.toString());
+        }
+    }
+    /**
+     * Is the property a number.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static number(source, property, value) {
+        if (!Is.number(value)) {
+            throw new GuardError(source, "guard.number", property, value);
+        }
+    }
+    /**
+     * Is the property an integer.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static integer(source, property, value) {
+        if (!Is.integer(value)) {
+            throw new GuardError(source, "guard.integer", property, value);
+        }
+    }
+    /**
+     * Is the property a bigint.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static bigint(source, property, value) {
+        if (!Is.bigint(value)) {
+            throw new GuardError(source, "guard.bigint", property, value);
+        }
+    }
+    /**
+     * Is the property a boolean.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static boolean(source, property, value) {
+        if (!Is.boolean(value)) {
+            throw new GuardError(source, "guard.boolean", property, value);
+        }
+    }
+    /**
+     * Is the property a date.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static date(source, property, value) {
+        if (!Is.date(value)) {
+            throw new GuardError(source, "guard.date", property, value);
+        }
+    }
+    /**
+     * Is the property a timestamp in milliseconds.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static timestampMilliseconds(source, property, value) {
+        if (!Is.timestampMilliseconds(value)) {
+            throw new GuardError(source, "guard.timestampMilliseconds", property, value);
+        }
+    }
+    /**
+     * Is the property a timestamp in seconds.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static timestampSeconds(source, property, value) {
+        if (!Is.timestampSeconds(value)) {
+            throw new GuardError(source, "guard.timestampSeconds", property, value);
+        }
+    }
+    /**
+     * Is the property an object.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static object(source, property, value) {
+        if (Is.undefined(value)) {
+            throw new GuardError(source, "guard.objectUndefined", property, value);
+        }
+        if (!Is.object(value)) {
+            throw new GuardError(source, "guard.object", property, value);
+        }
+    }
+    /**
+     * Is the property is an object with at least one property.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static objectValue(source, property, value) {
+        if (Is.undefined(value)) {
+            throw new GuardError(source, "guard.objectUndefined", property, value);
+        }
+        if (!Is.object(value)) {
+            throw new GuardError(source, "guard.object", property, value);
+        }
+        if (Object.keys(value || {}).length === 0) {
+            throw new GuardError(source, "guard.objectValue", property, value);
+        }
+    }
+    /**
+     * Is the property is an array.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static array(source, property, value) {
+        if (!Is.array(value)) {
+            throw new GuardError(source, "guard.array", property, value);
+        }
+    }
+    /**
+     * Is the property is an array with at least one item.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static arrayValue(source, property, value) {
+        if (!Is.array(value)) {
+            throw new GuardError(source, "guard.array", property, value);
+        }
+        if (value.length === 0) {
+            throw new GuardError(source, "guard.arrayValue", property, value);
+        }
+    }
+    /**
+     * Is the property one of a list of items.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param options The options the value must be one of.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static arrayOneOf(source, property, value, options) {
+        if (!Is.array(options)) {
+            throw new GuardError(source, "guard.array", property, value);
+        }
+        if (!options.includes(value)) {
+            throw new GuardError(source, "guard.arrayOneOf", property, value, options.join(", "));
+        }
+    }
+    /**
+     * Does the array start with the specified data.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param startValues The values that must start the array.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static arrayStartsWith(source, property, value, startValues) {
+        if (!Is.arrayValue(value)) {
+            throw new GuardError(source, "guard.array", property, value);
+        }
+        const startValuesArray = ArrayHelper.fromObjectOrArray(startValues);
+        if (!Is.arrayValue(startValuesArray)) {
+            throw new GuardError(source, "guard.array", property, startValuesArray);
+        }
+        for (let i = 0; i < startValuesArray.length; i++) {
+            if (value[i] !== startValuesArray[i]) {
+                throw new GuardError(source, "guard.arrayStartsWith", property, value, startValuesArray.join(", "));
+            }
+        }
+    }
+    /**
+     * Does the array end with the specified data.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param endValues The values that must end the array.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static arrayEndsWith(source, property, value, endValues) {
+        if (!Is.arrayValue(value)) {
+            throw new GuardError(source, "guard.array", property, value);
+        }
+        const endValuesArray = ArrayHelper.fromObjectOrArray(endValues);
+        if (!Is.arrayValue(endValuesArray)) {
+            throw new GuardError(source, "guard.array", property, endValuesArray);
+        }
+        for (let i = 0; i < endValuesArray.length; i++) {
+            if (value[value.length - i - 1] !== endValuesArray[endValuesArray.length - i - 1]) {
+                throw new GuardError(source, "guard.arrayEndsWith", property, value, endValuesArray.join(", "));
+            }
+        }
+    }
+    /**
+     * Is the property a Uint8Array.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static uint8Array(source, property, value) {
+        if (!Is.uint8Array(value)) {
+            throw new GuardError(source, "guard.uint8Array", property, value);
+        }
+    }
+    /**
+     * Is the property a function.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static function(source, property, value) {
+        if (!Is.function(value)) {
+            throw new GuardError(source, "guard.function", property, value);
+        }
+    }
+    /**
+     * Is the property a string formatted as an email address.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static email(source, property, value) {
+        if (!Is.email(value)) {
+            throw new GuardError(source, "guard.email", property, value);
+        }
+    }
+}
+//# sourceMappingURL=guards.js.map