@twin.org/core 0.0.1-next.3 → 0.0.1-next.30

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
-import { IntlMessageFormat } from 'intl-messageformat';
 import { createPatch, applyPatch } from 'rfc6902';
+import { IntlMessageFormat } from 'intl-messageformat';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -111,7 +111,12 @@ class Is {
         }
         try {
             const json = JSON.parse(value);
-            return typeof json === "object";
+            return (Is.object(json) ||
+                Is.array(json) ||
+                Is.string(json) ||
+                Is.number(json) ||
+                Is.boolean(json) ||
+                Is.null(json));
         }
         catch {
             return false;
@@ -137,6 +142,16 @@ class Is {
             // eslint-disable-next-line unicorn/better-regex
             /^(?:[A-Za-z0-9-_]{4})*(?:[A-Za-z0-9-_]{2}==|[A-Za-z0-9-_]{3}=)?$/.test(value));
     }
+    /**
+     * Is the value a base58 string.
+     * @param value The value to test.
+     * @returns True if the value is a base58 string.
+     */
+    static stringBase58(value) {
+        return (Is.stringValue(value) &&
+            // eslint-disable-next-line unicorn/better-regex
+            /^[A-HJ-NP-Za-km-z1-9]*$/.test(value));
+    }
     /**
      * Is the value a hex string.
      * @param value The value to test.
@@ -349,6 +364,14 @@ class Is {
     static promise(value) {
         return value instanceof Promise;
     }
+    /**
+     * Is the value a regexp.
+     * @param value The value to test.
+     * @returns True if the value is a regexp.
+     */
+    static regexp(value) {
+        return value instanceof RegExp;
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -898,6 +921,127 @@ class Base32 {
     }
 }
 
+/**
+ * Class to help with base58 Encoding/Decoding.
+ */
+class Base58 {
+    /**
+     * Runtime name for the class.
+     * @internal
+     */
+    static _CLASS_NAME = "Base58";
+    /**
+     * Alphabet table for encoding.
+     * @internal
+     */
+    static _ALPHABET = 
+    // cspell:disable-next-line
+    "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
+    /**
+     * Reverse map for decoding.
+     * @internal
+     */
+    static _ALPHABET_REVERSE = [
+        -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+        -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+        -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, -1, -1, -1, -1, -1, -1, -1, 9, 10, 11, 12, 13, 14, 15, 16, -1,
+        17, 18, 19, 20, 21, -1, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, -1, -1, -1, -1, -1, -1, 33,
+        34, 35, 36, 37, 38, 39, 40, 41, 42, 43, -1, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56,
+        57, -1, -1, -1, -1, -1
+    ];
+    /**
+     * Convert the base 58 string to a byte array.
+     * @param base58 The base58 string to convert.
+     * @returns The byte array.
+     * @throws If the input string contains a character not in the Base58 alphabet.
+     */
+    static decode(base58) {
+        let zeroes = 0;
+        for (let i = 0; i < base58.length; i++) {
+            if (base58[i] !== "1") {
+                break;
+            }
+            zeroes += 1;
+        }
+        const size = Math.trunc((base58.length * 733) / 1000) + 1;
+        const b256 = new Uint8Array(size).fill(0);
+        let length = 0;
+        for (let i = zeroes; i < base58.length; i++) {
+            const ch = base58.charCodeAt(i);
+            if (ch & 0xff80) {
+                throw new GeneralError(Base58._CLASS_NAME, "invalidCharacter", { invalidCharacter: ch });
+            }
+            const val = Base58._ALPHABET_REVERSE[ch];
+            if (val === -1) {
+                throw new GeneralError(Base58._CLASS_NAME, "invalidCharacter", { invalidCharacter: ch });
+            }
+            let carry = val;
+            let j = 0;
+            for (let k = size - 1; k >= 0; k--, j++) {
+                if (carry === 0 && j >= length) {
+                    break;
+                }
+                carry += b256[k] * 58;
+                b256[k] = carry;
+                carry >>>= 8;
+            }
+            length = j;
+        }
+        const out = new Uint8Array(zeroes + length);
+        let j;
+        for (j = 0; j < zeroes; j++) {
+            out[j] = 0;
+        }
+        let i = size - length;
+        while (i < size) {
+            out[j++] = b256[i++];
+        }
+        return out;
+    }
+    /**
+     * Convert a byte array to base 58.
+     * @param bytes The byte array to encode.
+     * @returns The data as base58 string.
+     */
+    static encode(bytes) {
+        let zeroes = 0;
+        for (let i = 0; i < bytes.length; i++) {
+            if (bytes[i] !== 0) {
+                break;
+            }
+            zeroes += 1;
+        }
+        const size = Math.trunc(((bytes.length - zeroes) * 138) / 100) + 1;
+        const b58 = new Uint8Array(size).fill(0);
+        let length = 0;
+        for (let i = zeroes; i < bytes.length; i++) {
+            let carry = bytes[i];
+            let j = 0;
+            for (let k = size - 1; k >= 0; k--, j++) {
+                if (carry === 0 && j >= length) {
+                    break;
+                }
+                carry += b58[k] * 256;
+                b58[k] = carry % 58;
+                carry = Math.trunc(carry / 58);
+            }
+            length = j;
+        }
+        let i = size - length;
+        while (i < size && b58[i] === 0) {
+            i += 1;
+        }
+        let str = "";
+        for (let j = 0; j < zeroes; j++) {
+            str += "1";
+        }
+        while (i < size) {
+            str += Base58._ALPHABET[b58[i++]];
+        }
+        return str;
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /* eslint-disable no-bitwise */
@@ -1052,7 +1196,7 @@ class Base64 {
         const maxChunkLength = 16383; // must be multiple of 3
         // go through the array every three bytes, we'll deal with trailing stuff later
         for (let i = 0, len2 = len - extraBytes; i < len2; i += maxChunkLength) {
-            parts.push(Base64.encodeChunk(bytes, i, i + maxChunkLength > len2 ? len2 : i + maxChunkLength));
+            parts.push(Base64.encodeChunk(bytes, i, Math.min(i + maxChunkLength, len2)));
         }
         // pad the end with zeros, but make sure to not forget the extra bytes
         if (extraBytes === 1) {
@@ -1393,6 +1537,18 @@ class Guards {
             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.
@@ -1417,6 +1573,18 @@ class Guards {
             throw new GuardError(source, "guard.base64Url", 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.base58", property, value);
+        }
+    }
     /**
      * Is the property a string with a hex value.
      * @param source The source of the error.
@@ -1718,6 +1886,29 @@ class Factory {
         }
         return Factory._factories[typeName];
     }
+    /**
+     * Get all the factories.
+     * @returns All the factories.
+     */
+    static getFactories() {
+        return Factory._factories;
+    }
+    /**
+     * Reset all the factories, which removes any created instances, but not the registrations.
+     */
+    static resetFactories() {
+        for (const typeName in Factory._factories) {
+            Factory._factories[typeName].reset();
+        }
+    }
+    /**
+     * Clear all the factories, which removes anything registered with the factories.
+     */
+    static clearFactories() {
+        for (const typeName in Factory._factories) {
+            Factory._factories[typeName].clear();
+        }
+    }
     /**
      * Register a new generator.
      * @param name The name of the generator.
@@ -1789,7 +1980,7 @@ class Factory {
         }
     }
     /**
-     * Reset all the instances.
+     * Remove all the instances and leave the generators intact.
      */
     reset() {
         for (const name in this._generators) {
@@ -1797,6 +1988,14 @@ class Factory {
         }
         this._instances = {};
     }
+    /**
+     * Remove all the instances and the generators.
+     */
+    clear() {
+        this._instances = {};
+        this._generators = {};
+        this._orderCounter = 0;
+    }
     /**
      * Get all the instances as a map.
      * @returns The instances as a map.
@@ -1902,244 +2101,252 @@ class ArrayHelper {
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+/* eslint-disable no-bitwise */
 /**
- * Class to perform internationalization.
+ * Convert arrays to and from different formats.
  */
-class I18n {
-    /**
-     * The default translation.
-     */
-    static DEFAULT_LOCALE = "en";
-    /**
-     * Dictionaries for lookups.
-     * @internal
-     */
-    static _localeDictionaries = {};
-    /**
-     * The current locale.
-     * @internal
-     */
-    static _currentLocale = I18n.DEFAULT_LOCALE;
+class Converter {
     /**
-     * Change handler for the locale being updated.
+     * Lookup table for encoding.
      * @internal
      */
-    static _localeChangedHandlers = {};
+    static _ENCODE_LOOKUP;
     /**
-     * Change handler for the dictionaries being updated.
+     * Lookup table for decoding.
      * @internal
      */
-    static _dictionaryChangedHandlers = {};
+    static _DECODE_LOOKUP;
     /**
-     * Set the locale.
-     * @param locale The new locale.
+     * 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 setLocale(locale) {
-        I18n._currentLocale = locale;
-        for (const callback in I18n._localeChangedHandlers) {
-            I18n._localeChangedHandlers[callback](I18n._currentLocale);
+    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;
     }
     /**
-     * Get the locale.
-     * @returns The current locale.
+     * Convert a UTF8 string to raw array.
+     * @param utf8 The text to decode.
+     * @returns The array.
      */
-    static getLocale() {
-        return I18n._currentLocale;
+    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);
     }
     /**
-     * Add a locale dictionary.
-     * @param locale The locale.
-     * @param dictionary The dictionary to add.
+     * 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 addDictionary(locale, dictionary) {
-        const mergedKeys = {};
-        I18n.flattenTranslationKeys(dictionary, "", mergedKeys);
-        I18n._localeDictionaries[locale] = mergedKeys;
-        for (const callback in I18n._dictionaryChangedHandlers) {
-            I18n._dictionaryChangedHandlers[callback](I18n._currentLocale);
+    static bytesToHex(array, includePrefix = false, startIndex, length, reverse) {
+        let hex = "";
+        this.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;
     }
     /**
-     * Get a locale dictionary.
-     * @param locale The locale.
-     * @returns The dictionary of undefined if it does not exist.
+     * Decode a hex string to raw array.
+     * @param hex The hex to decode.
+     * @param reverse Store the characters in reverse.
+     * @returns The array.
      */
-    static getDictionary(locale) {
-        return I18n._localeDictionaries[locale];
+    static hexToBytes(hex, reverse) {
+        const strippedHex = HexHelper.stripPrefix(hex);
+        const sizeof = strippedHex.length >> 1;
+        const length = sizeof << 1;
+        const array = new Uint8Array(sizeof);
+        this.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;
     }
     /**
-     * Get all the locale dictionaries.
-     * @returns The dictionaries.
+     * 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 getAllDictionaries() {
-        return I18n._localeDictionaries;
+    static utf8ToHex(utf8, includePrefix = false) {
+        const hex = Converter.bytesToHex(Converter.utf8ToBytes(utf8));
+        return includePrefix ? HexHelper.addPrefix(hex) : hex;
     }
     /**
-     * Add a locale changed handler.
-     * @param id The id of the handler.
-     * @param handler The handler to add.
+     * Convert the hex text to text.
+     * @param hex The hex to convert.
+     * @returns The UTF8 version of the bytes.
      */
-    static addLocaleHandler(id, handler) {
-        I18n._localeChangedHandlers[id] = handler;
+    static hexToUtf8(hex) {
+        return Converter.bytesToUtf8(Converter.hexToBytes(HexHelper.stripPrefix(hex)));
     }
     /**
-     * Remove a locale changed handler.
-     * @param id The id of the handler.
+     * Convert bytes to binary string.
+     * @param bytes The bytes to convert.
+     * @returns A binary string of the bytes.
      */
-    static removeLocaleHandler(id) {
-        delete I18n._localeChangedHandlers[id];
+    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("");
     }
     /**
-     * Add a dictionary changed handler.
-     * @param id The id of the handler.
-     * @param handler The handler to add.
+     * Convert a binary string to bytes.
+     * @param binary The binary string.
+     * @returns The bytes.
      */
-    static addDictionaryHandler(id, handler) {
-        I18n._dictionaryChangedHandlers[id] = handler;
+    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;
     }
     /**
-     * Remove a dictionary changed handler.
-     * @param id The id of the handler.
+     * Convert bytes to base64 string.
+     * @param bytes The bytes to convert.
+     * @returns A base64 string of the bytes.
      */
-    static removeDictionaryHandler(id) {
-        delete I18n._dictionaryChangedHandlers[id];
+    static bytesToBase64(bytes) {
+        return Base64.encode(bytes);
     }
     /**
-     * Format a message.
-     * @param key The key of the message to format.
-     * @param values The values to substitute into the message.
-     * @param overrideLocale Override the locale.
-     * @returns The formatted string.
+     * Convert a base64 string to bytes.
+     * @param base64 The base64 string.
+     * @returns The bytes.
      */
-    static formatMessage(key, values, overrideLocale) {
-        let cl = overrideLocale ?? I18n._currentLocale;
-        if (cl.startsWith("debug-")) {
-            cl = I18n.DEFAULT_LOCALE;
-        }
-        if (!I18n._localeDictionaries[cl]) {
-            return `!!Missing ${cl}`;
-        }
-        if (!I18n._localeDictionaries[cl][key]) {
-            return `!!Missing ${cl}.${key}`;
-        }
-        if (I18n._currentLocale === "debug-k") {
-            return key;
-        }
-        let ret = new IntlMessageFormat(I18n._localeDictionaries[cl][key], cl).format(values);
-        if (I18n._currentLocale === "debug-x") {
-            ret = ret.replace(/[a-z]/g, "x").replace(/[A-Z]/g, "x").replace(/\d/g, "n");
-        }
-        return ret;
+    static base64ToBytes(base64) {
+        return Base64.decode(base64);
     }
     /**
-     * Check if the dictionaries have a message for the given key.
-     * @param key The key to check for existence.
-     * @returns True if the key exists.
+     * Convert bytes to base64 url string.
+     * @param bytes The bytes to convert.
+     * @returns A base64 url string of the bytes.
      */
-    static hasMessage(key) {
-        return Is.string(I18n._localeDictionaries[I18n._currentLocale]?.[key]);
+    static bytesToBase64Url(bytes) {
+        return Base64Url.encode(bytes);
     }
     /**
-     * Flatten the translation property paths for faster lookup.
-     * @param translation The translation to merge.
-     * @param propertyPath The current root path.
-     * @param mergedKeys The merged keys dictionary to populate.
-     * @internal
+     * Convert a base64 url string to bytes.
+     * @param base64Url The base64 url string.
+     * @returns The bytes.
      */
-    static flattenTranslationKeys(translation, propertyPath, mergedKeys) {
-        for (const key in translation) {
-            const val = translation[key];
-            const mergedPath = propertyPath.length > 0 ? `${propertyPath}.${key}` : key;
-            if (Is.string(val)) {
-                mergedKeys[mergedPath] = val;
-            }
-            else if (Is.object(val)) {
-                I18n.flattenTranslationKeys(val, mergedPath, mergedKeys);
-            }
-        }
+    static base64UrlToBytes(base64Url) {
+        return Base64Url.decode(base64Url);
     }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Error helper functions.
- */
-class ErrorHelper {
     /**
-     * Format Errors and returns just their messages.
-     * @param error The error to format.
-     * @returns The error formatted including any inner errors.
+     * Convert bytes to base58 string.
+     * @param bytes The bytes to convert.
+     * @returns A base58 string of the bytes.
      */
-    static formatErrors(error) {
-        return ErrorHelper.localizeErrors(error).map(e => e.message);
+    static bytesToBase58(bytes) {
+        return Base58.encode(bytes);
     }
     /**
-     * Localize the content of an error and any inner errors.
-     * @param error The error to format.
-     * @returns The localized version of the errors flattened.
+     * Convert a base58 string to bytes.
+     * @param base58 The base58 string.
+     * @returns The bytes.
      */
-    static localizeErrors(error) {
-        const formattedErrors = [];
-        if (Is.notEmpty(error)) {
-            const errors = BaseError.flatten(error);
-            for (const err of errors) {
-                const errorNameKey = `errorNames.${StringHelper.camelCase(err.name)}`;
-                const errorMessageKey = `error.${err.message}`;
-                // If there is no error message then it is probably
-                // from a 3rd party lib, so don't format it just display
-                const hasErrorName = I18n.hasMessage(errorNameKey);
-                const hasErrorMessage = I18n.hasMessage(errorMessageKey);
-                const localizedError = {
-                    name: I18n.formatMessage(hasErrorName ? errorNameKey : "errorNames.error"),
-                    message: hasErrorMessage
-                        ? I18n.formatMessage(errorMessageKey, err.properties)
-                        : err.message
-                };
-                if (Is.stringValue(err.source)) {
-                    localizedError.source = err.source;
-                }
-                if (Is.stringValue(err.stack)) {
-                    // Remove the first line from the stack traces as they
-                    // just have the error type and message duplicated
-                    const lines = err.stack.split("\n");
-                    lines.shift();
-                    localizedError.stack = lines.join("\n");
-                }
-                const additional = ErrorHelper.formatValidationErrors(err);
-                if (Is.stringValue(additional)) {
-                    localizedError.additional = additional;
-                }
-                formattedErrors.push(localizedError);
-            }
-        }
-        return formattedErrors;
+    static base58ToBytes(base58) {
+        return Base58.decode(base58);
     }
     /**
-     * Localize the content of an error and any inner errors.
-     * @param error The error to format.
-     * @returns The localized version of the errors flattened.
+     * Build the static lookup tables.
+     * @internal
      */
-    static formatValidationErrors(error) {
-        if (Is.object(error.properties) &&
-            Object.keys(error.properties).length > 0 &&
-            Is.object(error.properties) &&
-            Is.arrayValue(error.properties.validationFailures)) {
-            const validationErrors = [];
-            for (const validationFailure of error.properties.validationFailures) {
-                const errorI18n = `error.${validationFailure.reason}`;
-                const errorMessage = I18n.hasMessage(errorI18n)
-                    ? I18n.formatMessage(errorI18n, validationFailure.properties)
-                    : errorI18n;
-                let v = `${validationFailure.property}: ${errorMessage}`;
-                if (Is.object(validationFailure.properties) &&
-                    Is.notEmpty(validationFailure.properties.value)) {
-                    v += ` = ${JSON.stringify(validationFailure.properties.value)}`;
+    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;
+                    }
                 }
-                validationErrors.push(v);
             }
-            return validationErrors.join("\n");
         }
     }
 }
@@ -2147,707 +2354,1019 @@ class ErrorHelper {
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * Coerce an object from one type to another.
+ * Helpers methods for JSON objects.
  */
-class Coerce {
+class JsonHelper {
     /**
-     * Coerce the value to a string.
-     * @param value The value to coerce.
-     * @throws TypeError If the value can not be coerced.
-     * @returns The value if it can be coerced.
+     * Serializes in canonical format.
+     * Based on https://www.rfc-editor.org/rfc/rfc8785.
+     * @param object The object to be serialized.
+     * @returns The serialized object.
      */
-    static string(value) {
-        if (Is.undefined(value)) {
-            return value;
-        }
-        if (Is.string(value)) {
-            return value;
-        }
-        if (Is.number(value)) {
-            return value.toString();
+    static canonicalize(object) {
+        const buffer = [];
+        if (object === null ||
+            typeof object !== "object" ||
+            ("toJSON" in object && object.toJSON instanceof Function)) {
+            // Primitive data type
+            buffer.push(JSON.stringify(object));
         }
-        if (Is.boolean(value)) {
-            return value ? "true" : "false";
+        else if (Array.isArray(object)) {
+            // Array maintain element order
+            const parts = [];
+            for (const element of object) {
+                if (element === undefined) {
+                    parts.push("null");
+                }
+                else {
+                    parts.push(JsonHelper.canonicalize(element));
+                }
+            }
+            buffer.push(`[${parts.join(",")}]`);
         }
-        if (Is.date(value)) {
-            return value.toISOString();
+        else {
+            // Object sort properties
+            const props = [];
+            const keys = Object.keys(object).sort();
+            const o = object;
+            for (const key of keys) {
+                if (o[key] !== undefined) {
+                    props.push(`${JSON.stringify(key)}:${JsonHelper.canonicalize(o[key])}`);
+                }
+            }
+            buffer.push(`{${props.join(",")}}`);
         }
+        return buffer.join("");
     }
     /**
-     * Coerce the value to a number.
-     * @param value The value to coerce.
-     * @throws TypeError If the value can not be coerced.
-     * @returns The value if it can be coerced.
-     */
-    static number(value) {
-        if (Is.undefined(value)) {
-            return value;
-        }
-        if (Is.number(value)) {
-            return value;
-        }
-        if (Is.string(value)) {
-            const parsed = Number.parseFloat(value);
-            if (Is.number(parsed)) {
-                return parsed;
-            }
-        }
-        if (Is.boolean(value)) {
-            return value ? 1 : 0;
-        }
-        if (Is.date(value)) {
-            return value.getTime();
-        }
+     * Creates a RFC 6902 diff set.
+     * Based on https://www.rfc-editor.org/rfc/rfc6902.
+     * @param object1 The first object.
+     * @param object2 The second object.
+     * @returns The list of patches.
+     */
+    static diff(object1, object2) {
+        const operations = createPatch(object1, object2);
+        return operations;
     }
     /**
-     * Coerce the value to a bigint.
-     * @param value The value to coerce.
-     * @throws TypeError If the value can not be coerced.
-     * @returns The value if it can be coerced.
+     * Applies a RFC 6902 diff set to an object.
+     * Based on https://www.rfc-editor.org/rfc/rfc6902.
+     * @param object The object to patch.
+     * @param patches The second object.
+     * @returns The updated object.
      */
-    static bigint(value) {
-        if (Is.undefined(value)) {
-            return value;
-        }
-        if (Is.bigint(value)) {
-            return value;
-        }
-        if (Is.number(value)) {
-            return BigInt(value);
-        }
-        if (Is.string(value)) {
-            const parsed = Number.parseFloat(value);
-            if (Is.integer(parsed)) {
-                return BigInt(parsed);
-            }
-        }
-        if (Is.boolean(value)) {
-            return value ? 1n : 0n;
-        }
+    static patch(object, patches) {
+        return applyPatch(object, patches);
     }
     /**
-     * Coerce the value to a boolean.
-     * @param value The value to coerce.
-     * @throws TypeError If the value can not be coerced.
-     * @returns The value if it can be coerced.
+     * Stringify the JSON with support for extended data types date/bigint/uint8array.
+     * @param object The object to stringify.
+     * @param space Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
+     * @returns The stringified object.
      */
-    static boolean(value) {
-        if (Is.undefined(value)) {
-            return value;
-        }
-        if (Is.boolean(value)) {
-            return value;
-        }
-        if (Is.number(value)) {
-            // eslint-disable-next-line no-unneeded-ternary
-            return value ? true : false;
-        }
-        if (Is.string(value)) {
-            if (/true/i.test(value)) {
-                return true;
+    static stringifyEx(object, space) {
+        // We want to keep the 'this' intact for the replacer
+        // eslint-disable-next-line @typescript-eslint/unbound-method
+        return JSON.stringify(object, JsonHelper.stringifyExReplacer, space);
+    }
+    /**
+     * Parse the JSON string with support for extended data types date/bigint/uint8array.
+     * @param json The object to pause.
+     * @returns The object.
+     */
+    static parseEx(json) {
+        // We want to keep the 'this' intact for the reviver
+        // eslint-disable-next-line @typescript-eslint/unbound-method
+        return JSON.parse(json, JsonHelper.parseExReviver);
+    }
+    /**
+     * Replacer function to handle extended data types.
+     * @param this The object.
+     * @param key The key.
+     * @param value The value.
+     * @returns The value.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static stringifyExReplacer(key, value) {
+        const rawValue = this[key];
+        if (Is.bigint(rawValue)) {
+            return {
+                "@ext": "bigint",
+                value: rawValue.toString()
+            };
+        }
+        else if (Is.date(rawValue)) {
+            return {
+                "@ext": "date",
+                value: rawValue.getTime()
+            };
+        }
+        else if (Is.uint8Array(rawValue)) {
+            return {
+                "@ext": "uint8array",
+                value: Converter.bytesToBase64(rawValue)
+            };
+        }
+        return value;
+    }
+    /**
+     * Reviver function to handle extended data types.
+     * @param this The object.
+     * @param key The key.
+     * @param value The value.
+     * @returns The value.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static parseExReviver(key, value) {
+        if (Is.object(value)) {
+            if (value["@ext"] === "bigint") {
+                return BigInt(value.value);
             }
-            if (/false/i.test(value)) {
-                return false;
+            else if (value["@ext"] === "date") {
+                return new Date(value.value);
+            }
+            else if (value["@ext"] === "uint8array") {
+                return Converter.base64ToBytes(value.value);
             }
         }
+        return value;
     }
+}
+
+/**
+ * Class to help with objects.
+ */
+class ObjectHelper {
     /**
-     * Coerce the value to a date.
-     * @param value The value to coerce.
-     * @throws TypeError If the value can not be coerced.
-     * @returns The value if it can be coerced.
+     * Runtime name for the class.
+     * @internal
      */
-    static date(value) {
-        if (Is.undefined(value)) {
-            return value;
-        }
-        if (Is.date(value)) {
-            return value;
-        }
-        if (Is.number(value)) {
-            return new Date(value);
-        }
-        if (Is.string(value)) {
-            const dt = new Date(value);
-            if (!Number.isNaN(dt.getTime())) {
-                const utc = Date.UTC(dt.getUTCFullYear(), dt.getUTCMonth(), dt.getUTCDate());
-                return new Date(utc);
-            }
+    static _CLASS_NAME = "ObjectHelper";
+    /**
+     * Convert an object to bytes.
+     * @param obj The object to convert.
+     * @param format Format the JSON content.
+     * @returns The object as bytes.
+     */
+    static toBytes(obj, format = false) {
+        if (obj === undefined) {
+            return new Uint8Array();
         }
+        const json = format ? JSON.stringify(obj, undefined, "\t") : JSON.stringify(obj);
+        return Converter.utf8ToBytes(json);
     }
     /**
-     * Coerce the value to a date/time.
-     * @param value The value to coerce.
-     * @throws TypeError If the value can not be coerced.
-     * @returns The value if it can be coerced.
+     * Convert a bytes to an object.
+     * @param bytes The bytes to convert to an object.
+     * @returns The object.
+     * @throws GeneralError if there was an error parsing the JSON.
      */
-    static dateTime(value) {
-        if (Is.undefined(value)) {
-            return value;
-        }
-        if (Is.date(value)) {
-            return value;
+    static fromBytes(bytes) {
+        if (Is.empty(bytes) || bytes.length === 0) {
+            return undefined;
         }
-        if (Is.number(value)) {
-            return new Date(value);
+        try {
+            const utf8 = Converter.bytesToUtf8(bytes);
+            return JSON.parse(utf8);
         }
-        if (Is.string(value)) {
-            const dt = new Date(value);
-            if (!Number.isNaN(dt.getTime())) {
-                const utc = Date.UTC(dt.getUTCFullYear(), dt.getUTCMonth(), dt.getUTCDate(), dt.getUTCHours(), dt.getUTCMinutes(), dt.getUTCSeconds(), dt.getUTCMilliseconds());
-                return new Date(utc);
-            }
+        catch (err) {
+            throw new GeneralError(ObjectHelper._CLASS_NAME, "failedBytesToJSON", undefined, err);
         }
     }
     /**
-     * Coerce the value to a time.
-     * @param value The value to coerce.
-     * @throws TypeError If the value can not be coerced.
-     * @returns The value if it can be coerced.
+     * Make a deep clone of an object.
+     * @param obj The object to clone.
+     * @returns The objects clone.
      */
-    static time(value) {
-        if (Is.undefined(value)) {
-            return value;
+    static clone(obj) {
+        if (Is.undefined(obj)) {
+            return undefined;
         }
-        if (Is.date(value)) {
-            return value;
+        return structuredClone(obj);
+    }
+    /**
+     * Deep merge objects.
+     * @param obj1 The first object to merge.
+     * @param obj2 The second object to merge.
+     * @returns The combined deep merge of the objects.
+     */
+    static merge(obj1, obj2) {
+        if (Is.empty(obj1)) {
+            return ObjectHelper.clone(obj2);
         }
-        if (Is.number(value)) {
-            const dt = new Date(value);
-            dt.setFullYear(1970, 0, 1);
-            return dt;
+        if (Is.empty(obj2)) {
+            return ObjectHelper.clone(obj1);
         }
-        if (Is.string(value)) {
-            const dt = new Date(value);
-            if (!Number.isNaN(dt.getTime())) {
-                const utc = Date.UTC(1970, 0, 1, dt.getUTCHours(), dt.getUTCMinutes(), dt.getUTCSeconds(), dt.getUTCMilliseconds());
-                return new Date(utc);
+        const obj1Clone = ObjectHelper.clone(obj1);
+        if (Is.object(obj1Clone) && Is.object(obj2)) {
+            const keys = Object.keys(obj2);
+            for (const key of keys) {
+                if (Is.object(obj1Clone[key]) && Is.object(obj2[key])) {
+                    ObjectHelper.propertySet(obj1Clone, key, ObjectHelper.merge(obj1Clone[key], obj2[key]));
+                }
+                else {
+                    ObjectHelper.propertySet(obj1Clone, key, obj2[key]);
+                }
             }
         }
+        return obj1Clone;
     }
     /**
-     * Coerce the value to an object.
-     * @param value The value to coerce.
-     * @throws TypeError If the value can not be coerced.
-     * @returns The value if it can be coerced.
+     * Does one object equal another.
+     * @param obj1 The first object to compare.
+     * @param obj2 The second object to compare.
+     * @param strictPropertyOrder Should the properties be in the same order, defaults to true.
+     * @returns True is the objects are equal.
      */
-    static object(value) {
-        if (Is.undefined(value)) {
-            return value;
-        }
-        if (Is.object(value)) {
-            return value;
+    static equal(obj1, obj2, strictPropertyOrder) {
+        if (strictPropertyOrder ?? true) {
+            return JSON.stringify(obj1) === JSON.stringify(obj2);
         }
-        if (Is.stringValue(value)) {
-            try {
-                return JSON.parse(value);
+        return JsonHelper.canonicalize(obj1) === JsonHelper.canonicalize(obj2);
+    }
+    /**
+     * Get the property of an unknown object.
+     * @param obj The object to get the property from.
+     * @param property The property to get, can be separated by dots for nested path.
+     * @returns The property.
+     */
+    static propertyGet(obj, property) {
+        const pathParts = property.split(".");
+        let pathValue = obj;
+        for (const pathPart of pathParts) {
+            // Is the path part numeric i.e. an array index.
+            const arrayMatch = /^(\d+)$/.exec(pathPart);
+            if (arrayMatch) {
+                const arrayIndex = Number.parseInt(arrayMatch[1], 10);
+                if (Is.arrayValue(pathValue) && arrayIndex < pathValue.length) {
+                    // There is no prop name so this is a direct array index on the current object
+                    pathValue = pathValue[arrayIndex];
+                }
+                else {
+                    // Array index for non array object so return
+                    return undefined;
+                }
+            }
+            else if (Is.object(pathValue)) {
+                // No array part in path so assume object sub property
+                pathValue = pathValue[pathPart];
+            }
+            else {
+                return undefined;
             }
-            catch { }
         }
+        return pathValue;
     }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class to help with filenames.
- */
-class FilenameHelper {
     /**
-     * Replaces any unsafe characters in the filename.
-     * @param filename The filename to make safe.
-     * @returns The safe filename.
+     * Set the property of an unknown object.
+     * @param obj The object to set the property from.
+     * @param property The property to set.
+     * @param value The value to set.
+     * @throws GeneralError if the property target is not an object.
      */
-    static safeFilename(filename) {
-        let safe = Coerce.string(filename);
-        if (Is.empty(safe)) {
-            return "";
+    static propertySet(obj, property, value) {
+        const pathParts = property.split(".");
+        let pathValue = obj;
+        let parentObj;
+        for (let i = 0; i < pathParts.length; i++) {
+            const pathPart = pathParts[i];
+            // Is the path part numeric i.e. an array index.
+            const arrayMatch = /^(\d+)$/.exec(pathPart);
+            const arrayIndex = arrayMatch ? Number.parseInt(arrayMatch[1], 10) : -1;
+            if (i === pathParts.length - 1) {
+                // Last part of path so set the value
+                if (arrayIndex >= 0) {
+                    if (Is.array(pathValue)) {
+                        pathValue[arrayIndex] = value;
+                    }
+                    else {
+                        throw new GeneralError(ObjectHelper._CLASS_NAME, "cannotSetArrayIndex", {
+                            property,
+                            index: arrayIndex
+                        });
+                    }
+                }
+                else if (Is.object(pathValue)) {
+                    pathValue[pathPart] = value;
+                }
+                else {
+                    throw new GeneralError(ObjectHelper._CLASS_NAME, "cannotSetProperty", { property });
+                }
+            }
+            else {
+                parentObj = pathValue;
+                if (Is.object(pathValue)) {
+                    pathValue = pathValue[pathPart];
+                }
+                else if (Is.array(pathValue)) {
+                    pathValue = pathValue[arrayIndex];
+                }
+                if (Is.empty(pathValue)) {
+                    const nextArrayMatch = /^(\d+)$/.exec(pathParts[i + 1]);
+                    const nextArrayIndex = nextArrayMatch ? Number.parseInt(nextArrayMatch[1], 10) : -1;
+                    if (nextArrayIndex >= 0) {
+                        pathValue = [];
+                    }
+                    else {
+                        pathValue = {};
+                    }
+                    if (Is.object(parentObj)) {
+                        parentObj[pathPart] = pathValue;
+                    }
+                    else if (Is.array(parentObj)) {
+                        parentObj[arrayIndex] = pathValue;
+                    }
+                }
+            }
         }
-        // Common non filename characters
-        safe = safe.replace(/["*/:<>?\\|]/g, "_");
-        // Windows non filename characters
-        safe = safe.replace(/^(con|prn|aux|nul|com\d|lpt\d)$/i, "_");
-        // Control characters
-        safe = safe.replace(/[\u0000-\u001F\u0080-\u009F]/g, "_");
-        // Relative paths
-        safe = safe.replace(/^\.+/, "_");
-        // Trailing periods
-        safe = safe.replace(/\.+$/, "");
-        return safe;
     }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Helpers methods for JSON objects.
- */
-class JsonHelper {
     /**
-     * Serializes in canonical format.
-     * Based on https://www.rfc-editor.org/rfc/rfc8785.
-     * @param object The object to be serialized.
-     * @returns The serialized object.
+     * Delete the property of an unknown object.
+     * @param obj The object to set the property from.
+     * @param property The property to set
      */
-    static canonicalize(object) {
-        const buffer = [];
-        if (object === null ||
-            typeof object !== "object" ||
-            ("toJSON" in object && object.toJSON instanceof Function)) {
-            // Primitive data type
-            buffer.push(JSON.stringify(object));
+    static propertyDelete(obj, property) {
+        if (Is.object(obj)) {
+            delete obj[property];
         }
-        else if (Array.isArray(object)) {
-            // Array maintain element order
-            const parts = [];
-            for (const element of object) {
-                if (element === undefined) {
-                    parts.push("null");
-                }
-                else {
-                    parts.push(JsonHelper.canonicalize(element));
+    }
+    /**
+     * Extract a property from the object, providing alternative names.
+     * @param obj The object to extract from.
+     * @param propertyNames The possible names for the property.
+     * @param removeProperties Remove the properties from the object, defaults to true.
+     * @returns The property if available.
+     */
+    static extractProperty(obj, propertyNames, removeProperties = true) {
+        let retVal;
+        if (Is.object(obj)) {
+            const names = Is.string(propertyNames) ? [propertyNames] : propertyNames;
+            for (const prop of names) {
+                retVal ??= ObjectHelper.propertyGet(obj, prop);
+                if (removeProperties) {
+                    ObjectHelper.propertyDelete(obj, prop);
                 }
             }
-            buffer.push(`[${parts.join(",")}]`);
         }
-        else {
-            // Object sort properties
-            const props = [];
-            const keys = Object.keys(object).sort();
-            const o = object;
+        return retVal;
+    }
+    /**
+     * Pick a subset of properties from an object.
+     * @param obj The object to pick the properties from.
+     * @param keys The property keys to pick.
+     * @returns The partial object.
+     */
+    static pick(obj, keys) {
+        if (Is.object(obj) && Is.arrayValue(keys)) {
+            const result = {};
             for (const key of keys) {
-                if (o[key] !== undefined) {
-                    props.push(`${JSON.stringify(key)}:${JsonHelper.canonicalize(o[key])}`);
-                }
+                result[key] = obj[key];
             }
-            buffer.push(`{${props.join(",")}}`);
+            return result;
         }
-        return buffer.join("");
+        return obj;
     }
     /**
-     * Creates a RFC 6902 diff set.
-     * Based on https://www.rfc-editor.org/rfc/rfc6902.
-     * @param object1 The first object.
-     * @param object2 The second object.
-     * @returns The list of patches.
+     * Omit a subset of properties from an object.
+     * @param obj The object to omit the properties from.
+     * @param keys The property keys to omit.
+     * @returns The partial object.
      */
-    static diff(object1, object2) {
-        const operations = createPatch(object1, object2);
-        return operations;
+    static omit(obj, keys) {
+        if (Is.object(obj) && Is.arrayValue(keys)) {
+            const result = { ...obj };
+            for (const key of keys) {
+                delete result[key];
+            }
+            return result;
+        }
+        return obj;
     }
-    /**
-     * Applies a RFC 6902 diff set to an object.
-     * Based on https://www.rfc-editor.org/rfc/rfc6902.
-     * @param object The object to patch.
-     * @param patches The second object.
-     * @returns The updated object.
-     */
-    static patch(object, patches) {
-        return applyPatch(object, patches);
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Environment variable helper.
+ */
+class EnvHelper {
+    /**
+     * Get the environment variable as an object with camel cased names.
+     * @param envVars The environment variables.
+     * @param prefix The prefix of the environment variables, if not provided gets all.
+     * @returns The object with camel cased names.
+     */
+    static envToJson(envVars, prefix) {
+        const result = {};
+        if (!Is.empty(envVars)) {
+            if (Is.empty(prefix)) {
+                for (const envVar in envVars) {
+                    if (Is.stringValue(envVars[envVar])) {
+                        const camelCaseName = StringHelper.camelCase(envVar.toLowerCase());
+                        ObjectHelper.propertySet(result, camelCaseName, envVars[envVar]);
+                    }
+                }
+            }
+            else {
+                for (const envVar in envVars) {
+                    if (envVar.startsWith(prefix) && Is.stringValue(envVars[envVar])) {
+                        const camelCaseName = StringHelper.camelCase(envVar.replace(prefix, "").toLowerCase());
+                        ObjectHelper.propertySet(result, camelCaseName, envVars[envVar]);
+                    }
+                }
+            }
+        }
+        return result;
     }
 }
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
-/* eslint-disable no-bitwise */
 /**
- * Convert arrays to and from different formats.
+ * Class to perform internationalization.
  */
-class Converter {
+class I18n {
     /**
-     * Lookup table for encoding.
+     * The default translation.
+     */
+    static DEFAULT_LOCALE = "en";
+    /**
+     * Dictionaries for lookups.
      * @internal
      */
-    static _ENCODE_LOOKUP;
+    static _localeDictionaries = {};
     /**
-     * Lookup table for decoding.
+     * The current locale.
      * @internal
      */
-    static _DECODE_LOOKUP;
+    static _currentLocale = I18n.DEFAULT_LOCALE;
     /**
-     * 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.
+     * Change handler for the locale being updated.
+     * @internal
      */
-    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;
-            }
+    static _localeChangedHandlers = {};
+    /**
+     * Change handler for the dictionaries being updated.
+     * @internal
+     */
+    static _dictionaryChangedHandlers = {};
+    /**
+     * Set the locale.
+     * @param locale The new locale.
+     */
+    static setLocale(locale) {
+        I18n._currentLocale = locale;
+        for (const callback in I18n._localeChangedHandlers) {
+            I18n._localeChangedHandlers[callback](I18n._currentLocale);
         }
-        return str;
     }
     /**
-     * Convert a UTF8 string to raw array.
-     * @param utf8 The text to decode.
-     * @returns The array.
+     * Get the locale.
+     * @returns The current locale.
      */
-    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));
+    static getLocale() {
+        return I18n._currentLocale;
+    }
+    /**
+     * Add a locale dictionary.
+     * @param locale The locale.
+     * @param dictionary The dictionary to add.
+     */
+    static addDictionary(locale, dictionary) {
+        const mergedKeys = {};
+        I18n.flattenTranslationKeys(dictionary, "", mergedKeys);
+        I18n._localeDictionaries[locale] = mergedKeys;
+        for (const callback in I18n._dictionaryChangedHandlers) {
+            I18n._dictionaryChangedHandlers[callback](I18n._currentLocale);
+        }
+    }
+    /**
+     * Get a locale dictionary.
+     * @param locale The locale.
+     * @returns The dictionary of undefined if it does not exist.
+     */
+    static getDictionary(locale) {
+        return I18n._localeDictionaries[locale];
+    }
+    /**
+     * Get all the locale dictionaries.
+     * @returns The dictionaries.
+     */
+    static getAllDictionaries() {
+        return I18n._localeDictionaries;
+    }
+    /**
+     * Add a locale changed handler.
+     * @param id The id of the handler.
+     * @param handler The handler to add.
+     */
+    static addLocaleHandler(id, handler) {
+        I18n._localeChangedHandlers[id] = handler;
+    }
+    /**
+     * Remove a locale changed handler.
+     * @param id The id of the handler.
+     */
+    static removeLocaleHandler(id) {
+        delete I18n._localeChangedHandlers[id];
+    }
+    /**
+     * Add a dictionary changed handler.
+     * @param id The id of the handler.
+     * @param handler The handler to add.
+     */
+    static addDictionaryHandler(id, handler) {
+        I18n._dictionaryChangedHandlers[id] = handler;
+    }
+    /**
+     * Remove a dictionary changed handler.
+     * @param id The id of the handler.
+     */
+    static removeDictionaryHandler(id) {
+        delete I18n._dictionaryChangedHandlers[id];
+    }
+    /**
+     * Format a message.
+     * @param key The key of the message to format.
+     * @param values The values to substitute into the message.
+     * @param overrideLocale Override the locale.
+     * @returns The formatted string.
+     */
+    static formatMessage(key, values, overrideLocale) {
+        let cl = overrideLocale ?? I18n._currentLocale;
+        if (cl.startsWith("debug-")) {
+            cl = I18n.DEFAULT_LOCALE;
+        }
+        if (!I18n._localeDictionaries[cl]) {
+            return `!!Missing ${cl}`;
+        }
+        if (!I18n._localeDictionaries[cl][key]) {
+            return `!!Missing ${cl}.${key}`;
+        }
+        if (I18n._currentLocale === "debug-k") {
+            return key;
+        }
+        let ret = new IntlMessageFormat(I18n._localeDictionaries[cl][key], cl).format(values);
+        if (I18n._currentLocale === "debug-x") {
+            ret = ret.replace(/[a-z]/g, "x").replace(/[A-Z]/g, "x").replace(/\d/g, "n");
+        }
+        return ret;
+    }
+    /**
+     * Check if the dictionaries have a message for the given key.
+     * @param key The key to check for existence.
+     * @returns True if the key exists.
+     */
+    static hasMessage(key) {
+        return Is.string(I18n._localeDictionaries[I18n._currentLocale]?.[key]);
+    }
+    /**
+     * Flatten the translation property paths for faster lookup.
+     * @param translation The translation to merge.
+     * @param propertyPath The current root path.
+     * @param mergedKeys The merged keys dictionary to populate.
+     * @internal
+     */
+    static flattenTranslationKeys(translation, propertyPath, mergedKeys) {
+        for (const key in translation) {
+            const val = translation[key];
+            const mergedPath = propertyPath.length > 0 ? `${propertyPath}.${key}` : key;
+            if (Is.string(val)) {
+                mergedKeys[mergedPath] = val;
             }
-            else if (charCode < 0xd800 || charCode >= 0xe000) {
-                bytes.push(0xe0 | (charCode >> 12), 0x80 | ((charCode >> 6) & 0x3f), 0x80 | (charCode & 0x3f));
+            else if (Is.object(val)) {
+                I18n.flattenTranslationKeys(val, mergedPath, mergedKeys);
             }
-            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));
+        }
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Error helper functions.
+ */
+class ErrorHelper {
+    /**
+     * Format Errors and returns just their messages.
+     * @param error The error to format.
+     * @returns The error formatted including any inner errors.
+     */
+    static formatErrors(error) {
+        return ErrorHelper.localizeErrors(error).map(e => e.message);
+    }
+    /**
+     * Localize the content of an error and any inner errors.
+     * @param error The error to format.
+     * @returns The localized version of the errors flattened.
+     */
+    static localizeErrors(error) {
+        const formattedErrors = [];
+        if (Is.notEmpty(error)) {
+            const errors = BaseError.flatten(error);
+            for (const err of errors) {
+                const errorNameKey = `errorNames.${StringHelper.camelCase(err.name)}`;
+                const errorMessageKey = `error.${err.message}`;
+                // If there is no error message then it is probably
+                // from a 3rd party lib, so don't format it just display
+                const hasErrorName = I18n.hasMessage(errorNameKey);
+                const hasErrorMessage = I18n.hasMessage(errorMessageKey);
+                const localizedError = {
+                    name: I18n.formatMessage(hasErrorName ? errorNameKey : "errorNames.error"),
+                    message: hasErrorMessage
+                        ? I18n.formatMessage(errorMessageKey, err.properties)
+                        : err.message
+                };
+                if (Is.stringValue(err.source)) {
+                    localizedError.source = err.source;
+                }
+                if (Is.stringValue(err.stack)) {
+                    // Remove the first line from the stack traces as they
+                    // just have the error type and message duplicated
+                    const lines = err.stack.split("\n");
+                    lines.shift();
+                    localizedError.stack = lines.join("\n");
+                }
+                const additional = ErrorHelper.formatValidationErrors(err);
+                if (Is.stringValue(additional)) {
+                    localizedError.additional = additional;
+                }
+                formattedErrors.push(localizedError);
             }
         }
-        return Uint8Array.from(bytes);
+        return formattedErrors;
     }
     /**
-     * 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.
+     * Localize the content of an error and any inner errors.
+     * @param error The error to format.
+     * @returns The localized version of the errors flattened.
      */
-    static bytesToHex(array, includePrefix = false, startIndex, length, reverse) {
-        let hex = "";
-        this.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]];
+    static formatValidationErrors(error) {
+        if (Is.object(error.properties) &&
+            Object.keys(error.properties).length > 0 &&
+            Is.object(error.properties) &&
+            Is.arrayValue(error.properties.validationFailures)) {
+            const validationErrors = [];
+            for (const validationFailure of error.properties.validationFailures) {
+                const errorI18n = `error.${validationFailure.reason}`;
+                const errorMessage = I18n.hasMessage(errorI18n)
+                    ? I18n.formatMessage(errorI18n, validationFailure.properties)
+                    : errorI18n;
+                let v = `${validationFailure.property}: ${errorMessage}`;
+                if (Is.object(validationFailure.properties) &&
+                    Is.notEmpty(validationFailure.properties.value)) {
+                    v += ` = ${JSON.stringify(validationFailure.properties.value)}`;
                 }
+                validationErrors.push(v);
             }
+            return validationErrors.join("\n");
         }
-        return includePrefix ? HexHelper.addPrefix(hex) : hex;
     }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types the extracted data can be coerced to.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const CoerceType = {
     /**
-     * Decode a hex string to raw array.
-     * @param hex The hex to decode.
-     * @param reverse Store the characters in reverse.
-     * @returns The array.
+     * String.
      */
-    static hexToBytes(hex, reverse) {
-        const strippedHex = HexHelper.stripPrefix(hex);
-        const sizeof = strippedHex.length >> 1;
-        const length = sizeof << 1;
-        const array = new Uint8Array(sizeof);
-        this.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;
-    }
+    String: "string",
     /**
-     * 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.
+     * Number.
      */
-    static utf8ToHex(utf8, includePrefix = false) {
-        const hex = Converter.bytesToHex(Converter.utf8ToBytes(utf8));
-        return includePrefix ? HexHelper.addPrefix(hex) : hex;
-    }
+    Number: "number",
     /**
-     * Convert the hex text to text.
-     * @param hex The hex to convert.
-     * @returns The UTF8 version of the bytes.
+     * Integer.
      */
-    static hexToUtf8(hex) {
-        return Converter.bytesToUtf8(Converter.hexToBytes(HexHelper.stripPrefix(hex)));
-    }
+    Integer: "integer",
     /**
-     * Convert bytes to binary string.
-     * @param bytes The bytes to convert.
-     * @returns A binary string of the bytes.
+     * Boolean.
      */
-    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("");
-    }
+    Boolean: "boolean",
     /**
-     * Convert a binary string to bytes.
-     * @param binary The binary string.
-     * @returns The bytes.
+     * Big Integer.
      */
-    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;
-    }
+    BigInt: "bigint",
     /**
-     * Convert bytes to base64 string.
-     * @param bytes The bytes to convert.
-     * @returns A base64 string of the bytes.
+     * Date.
      */
-    static bytesToBase64(bytes) {
-        return Base64.encode(bytes);
-    }
+    Date: "date",
     /**
-     * Convert a base64 string to bytes.
-     * @param base64 The base64 string.
-     * @returns The bytes.
+     * Date Time.
      */
-    static base64ToBytes(base64) {
-        return Base64.decode(base64);
-    }
+    DateTime: "datetime",
     /**
-     * Convert bytes to base64 url string.
-     * @param bytes The bytes to convert.
-     * @returns A base64 url string of the bytes.
+     * Time.
      */
-    static bytesToBase64Url(bytes) {
-        return Base64Url.encode(bytes);
-    }
+    Time: "time",
     /**
-     * Convert a base64 url string to bytes.
-     * @param base64Url The base64 url string.
-     * @returns The bytes.
+     * Object.
      */
-    static base64UrlToBytes(base64Url) {
-        return Base64Url.decode(base64Url);
-    }
+    Object: "object",
     /**
-     * Build the static lookup tables.
-     * @internal
+     * Uint8Array.
      */
-    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;
-                    }
-                }
-            }
-        }
-    }
-}
+    Uint8Array: "uint8array"
+};
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
 /**
- * Class to help with objects.
+ * Coerce an object from one type to another.
  */
-class ObjectHelper {
+class Coerce {
     /**
-     * Runtime name for the class.
-     * @internal
+     * Coerce the value to a string.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
      */
-    static _CLASS_NAME = "ObjectHelper";
+    static string(value) {
+        if (Is.undefined(value)) {
+            return value;
+        }
+        if (Is.string(value)) {
+            return value;
+        }
+        if (Is.number(value)) {
+            return value.toString();
+        }
+        if (Is.boolean(value)) {
+            return value ? "true" : "false";
+        }
+        if (Is.date(value)) {
+            return value.toISOString();
+        }
+    }
     /**
-     * Convert an object to bytes.
-     * @param obj The object to convert.
-     * @param format Format the JSON content.
-     * @returns The object as bytes.
+     * Coerce the value to a number.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
      */
-    static toBytes(obj, format = false) {
-        if (obj === undefined) {
-            return new Uint8Array();
+    static number(value) {
+        if (Is.undefined(value)) {
+            return value;
+        }
+        if (Is.number(value)) {
+            return value;
+        }
+        if (Is.string(value)) {
+            const parsed = Number.parseFloat(value);
+            if (Is.number(parsed)) {
+                return parsed;
+            }
+        }
+        if (Is.boolean(value)) {
+            return value ? 1 : 0;
+        }
+        if (Is.date(value)) {
+            return value.getTime();
         }
-        const json = format ? JSON.stringify(obj, undefined, "\t") : JSON.stringify(obj);
-        return Converter.utf8ToBytes(json);
     }
     /**
-     * Convert a bytes to an object.
-     * @param bytes The bytes to convert to an object.
-     * @returns The object.
-     * @throws GeneralError if there was an error parsing the JSON.
+     * Coerce the value to an integer.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
      */
-    static fromBytes(bytes) {
-        if (Is.empty(bytes) || bytes.length === 0) {
-            return undefined;
+    static integer(value) {
+        const num = Coerce.number(value);
+        if (!Is.undefined(num)) {
+            return Math.trunc(num);
         }
-        try {
-            const utf8 = Converter.bytesToUtf8(bytes);
-            return JSON.parse(utf8);
+    }
+    /**
+     * Coerce the value to a bigint.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
+     */
+    static bigint(value) {
+        if (Is.undefined(value)) {
+            return value;
+        }
+        if (Is.bigint(value)) {
+            return value;
+        }
+        if (Is.number(value)) {
+            return BigInt(value);
         }
-        catch (err) {
-            throw new GeneralError(ObjectHelper._CLASS_NAME, "failedBytesToJSON", undefined, err);
+        if (Is.string(value)) {
+            const parsed = Number.parseFloat(value);
+            if (Is.integer(parsed)) {
+                return BigInt(parsed);
+            }
+        }
+        if (Is.boolean(value)) {
+            return value ? 1n : 0n;
         }
     }
     /**
-     * Make a deep clone of an object.
-     * @param obj The object to clone.
-     * @returns The objects clone.
+     * Coerce the value to a boolean.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
      */
-    static clone(obj) {
-        if (Is.undefined(obj)) {
-            return undefined;
+    static boolean(value) {
+        if (Is.undefined(value)) {
+            return value;
+        }
+        if (Is.boolean(value)) {
+            return value;
+        }
+        if (Is.number(value)) {
+            // eslint-disable-next-line no-unneeded-ternary
+            return value ? true : false;
+        }
+        if (Is.string(value)) {
+            if (/true/i.test(value)) {
+                return true;
+            }
+            if (/false/i.test(value)) {
+                return false;
+            }
         }
-        return structuredClone(obj);
     }
     /**
-     * Deep merge objects.
-     * @param obj1 The first object to merge.
-     * @param obj2 The second object to merge.
-     * @returns The combined deep merge of the objects.
+     * Coerce the value to a date.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
      */
-    static merge(obj1, obj2) {
-        if (Is.empty(obj1)) {
-            return ObjectHelper.clone(obj2);
+    static date(value) {
+        if (Is.undefined(value)) {
+            return value;
         }
-        if (Is.empty(obj2)) {
-            return ObjectHelper.clone(obj1);
+        if (Is.date(value)) {
+            return value;
         }
-        const obj1Clone = ObjectHelper.clone(obj1);
-        if (Is.object(obj1Clone) && Is.object(obj2)) {
-            const keys = Object.keys(obj2);
-            for (const key of keys) {
-                if (Is.object(obj1Clone[key]) && Is.object(obj2[key])) {
-                    ObjectHelper.propertySet(obj1Clone, key, ObjectHelper.merge(obj1Clone[key], obj2[key]));
-                }
-                else {
-                    ObjectHelper.propertySet(obj1Clone, key, obj2[key]);
-                }
+        if (Is.number(value)) {
+            return new Date(value);
+        }
+        if (Is.string(value)) {
+            const dt = new Date(value);
+            if (!Number.isNaN(dt.getTime())) {
+                const utc = Date.UTC(dt.getUTCFullYear(), dt.getUTCMonth(), dt.getUTCDate());
+                return new Date(utc);
             }
         }
-        return obj1Clone;
     }
     /**
-     * Does one object equal another.
-     * @param obj1 The first object to compare.
-     * @param obj2 The second object to compare.
-     * @param strictPropertyOrder Should the properties be in the same order, defaults to true.
-     * @returns True is the objects are equal.
+     * Coerce the value to a date/time.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
      */
-    static equal(obj1, obj2, strictPropertyOrder) {
-        if (strictPropertyOrder ?? true) {
-            return JSON.stringify(obj1) === JSON.stringify(obj2);
+    static dateTime(value) {
+        if (Is.undefined(value)) {
+            return value;
+        }
+        if (Is.date(value)) {
+            return value;
+        }
+        if (Is.number(value)) {
+            return new Date(value);
+        }
+        if (Is.string(value)) {
+            const dt = new Date(value);
+            if (!Number.isNaN(dt.getTime())) {
+                const utc = Date.UTC(dt.getUTCFullYear(), dt.getUTCMonth(), dt.getUTCDate(), dt.getUTCHours(), dt.getUTCMinutes(), dt.getUTCSeconds(), dt.getUTCMilliseconds());
+                return new Date(utc);
+            }
         }
-        return JsonHelper.canonicalize(obj1) === JsonHelper.canonicalize(obj2);
     }
     /**
-     * Get the property of an unknown object.
-     * @param obj The object to get the property from.
-     * @param property The property to get, can be separated by dots for nested path.
-     * @returns The property.
+     * Coerce the value to a time.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
      */
-    static propertyGet(obj, property) {
-        if (property.includes(".")) {
-            const parts = property.split(".");
-            let value = obj;
-            for (const part of parts) {
-                if (Is.object(value)) {
-                    value = value[part];
-                }
-                else {
-                    return undefined;
-                }
-            }
+    static time(value) {
+        if (Is.undefined(value)) {
+            return value;
+        }
+        if (Is.date(value)) {
             return value;
         }
-        return Is.object(obj) ? obj[property] : undefined;
+        if (Is.number(value)) {
+            const dt = new Date(value);
+            dt.setFullYear(1970, 0, 1);
+            return dt;
+        }
+        if (Is.string(value)) {
+            const dt = new Date(value);
+            if (!Number.isNaN(dt.getTime())) {
+                const utc = Date.UTC(1970, 0, 1, dt.getUTCHours(), dt.getUTCMinutes(), dt.getUTCSeconds(), dt.getUTCMilliseconds());
+                return new Date(utc);
+            }
+        }
     }
     /**
-     * Set the property of an unknown object.
-     * @param obj The object to set the property from.
-     * @param property The property to set.
-     * @param value The value to set.
+     * Coerce the value to an object.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
      */
-    static propertySet(obj, property, value) {
-        if (Is.object(obj)) {
-            obj[property] = value;
+    static object(value) {
+        if (Is.undefined(value)) {
+            return value;
+        }
+        if (Is.object(value)) {
+            return value;
+        }
+        if (Is.stringValue(value)) {
+            try {
+                return JSON.parse(value);
+            }
+            catch { }
         }
     }
     /**
-     * Delete the property of an unknown object.
-     * @param obj The object to set the property from.
-     * @param property The property to set
+     * Coerce the value to a Uint8Array.
+     * @param value The value to coerce.
+     * @throws TypeError If the value can not be coerced.
+     * @returns The value if it can be coerced.
      */
-    static propertyDelete(obj, property) {
-        if (Is.object(obj)) {
-            delete obj[property];
+    static uint8Array(value) {
+        if (Is.undefined(value)) {
+            return value;
+        }
+        if (Is.string(value)) {
+            if (Is.stringHex(value.toLowerCase(), true)) {
+                return Converter.hexToBytes(value.toLowerCase());
+            }
+            if (Is.stringBase64(value)) {
+                return Converter.base64ToBytes(value);
+            }
         }
     }
     /**
-     * Pick a subset of properties from an object.
-     * @param obj The object to pick the properties from.
-     * @param keys The property keys to pick.
-     * @returns The partial object.
-     */
-    static pick(obj, keys) {
-        if (Is.object(obj) && Is.arrayValue(keys)) {
-            const result = {};
-            for (const key of keys) {
-                result[key] = obj[key];
-            }
-            return result;
+     * Coerces a value based on the coercion type.
+     * @param value The value to coerce.
+     * @param type The coercion type to perform.
+     * @returns The coerced value.
+     */
+    static byType(value, type) {
+        switch (type) {
+            case CoerceType.String:
+                return Coerce.string(value);
+            case CoerceType.Number:
+                return Coerce.number(value);
+            case CoerceType.Integer:
+                return Coerce.integer(value);
+            case CoerceType.BigInt:
+                return Coerce.bigint(value);
+            case CoerceType.Boolean:
+                return Coerce.boolean(value);
+            case CoerceType.Date:
+                return Coerce.date(value);
+            case CoerceType.DateTime:
+                return Coerce.dateTime(value);
+            case CoerceType.Time:
+                return Coerce.time(value);
+            case CoerceType.Object:
+                return Coerce.object(value);
+            case CoerceType.Uint8Array:
+                return Coerce.uint8Array(value);
+            default:
+                return value;
         }
-        return obj;
     }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class to help with filenames.
+ */
+class FilenameHelper {
     /**
-     * Omit a subset of properties from an object.
-     * @param obj The object to omit the properties from.
-     * @param keys The property keys to omit.
-     * @returns The partial object.
+     * Replaces any unsafe characters in the filename.
+     * @param filename The filename to make safe.
+     * @returns The safe filename.
      */
-    static omit(obj, keys) {
-        if (Is.object(obj) && Is.arrayValue(keys)) {
-            const result = { ...obj };
-            for (const key of keys) {
-                delete result[key];
-            }
-            return result;
+    static safeFilename(filename) {
+        let safe = Coerce.string(filename);
+        if (Is.empty(safe)) {
+            return "";
         }
-        return obj;
+        // Common non filename characters
+        safe = safe.replace(/["*/:<>?\\|]/g, "_");
+        // Windows non filename characters
+        safe = safe.replace(/^(con|prn|aux|nul|com\d|lpt\d)$/i, "_");
+        // Control characters
+        safe = safe.replace(/[\u0000-\u001F\u0080-\u009F]/g, "_");
+        // Relative paths
+        safe = safe.replace(/^\.+/, "_");
+        // Trailing periods
+        safe = safe.replace(/\.+$/, "");
+        return safe;
     }
 }
 
@@ -2881,7 +3400,7 @@ const CompressionType = {
      */
     Gzip: "gzip",
     /**
-     * deflate.
+     * Deflate.
      */
     Deflate: "deflate"
 };
@@ -3504,6 +4023,7 @@ class Validation {
      * @param options Additional options for the validation.
      * @param options.minLength The minimum length of the string.
      * @param options.maxLength The maximum length of the string.
+     * @param options.format Specific format to check.
      * @returns True if the value is a valid string.
      */
     static string(property, value, failures, fieldNameResource, options) {
@@ -3522,6 +4042,47 @@ class Validation {
             const maxLimitDefined = Is.integer(maxLength);
             const belowMin = minLimitDefined && value.length < minLength;
             const aboveMax = maxLimitDefined && value.length > maxLength;
+            if (options?.format === "base58" && !Is.stringBase58(value)) {
+                failures.push({
+                    property,
+                    reason: "validation.beTextBase58",
+                    properties: {
+                        fieldName: fieldNameResource ?? "validation.defaultFieldName",
+                        value
+                    }
+                });
+            }
+            else if (options?.format === "base64" && !Is.stringBase64(value)) {
+                failures.push({
+                    property,
+                    reason: "validation.beTextBase64",
+                    properties: {
+                        fieldName: fieldNameResource ?? "validation.defaultFieldName",
+                        value
+                    }
+                });
+            }
+            else if (options?.format === "hex" && !Is.stringHex(value)) {
+                failures.push({
+                    property,
+                    reason: "validation.beTextHex",
+                    properties: {
+                        fieldName: fieldNameResource ?? "validation.defaultFieldName",
+                        value
+                    }
+                });
+            }
+            else if (Is.regexp(options?.format) && !options.format.test(value)) {
+                failures.push({
+                    property,
+                    reason: "validation.beTextRegExp",
+                    properties: {
+                        fieldName: fieldNameResource ?? "validation.defaultFieldName",
+                        value,
+                        format: options?.format
+                    }
+                });
+            }
             if (minLimitDefined && maxLimitDefined && (belowMin || aboveMax)) {
                 failures.push({
                     property,
@@ -4181,4 +4742,4 @@ class Validation {
     }
 }
 
-export { AlreadyExistsError, ArrayHelper, AsyncCache, Base32, Base64, Base64Url, BaseError, BitString, Coerce, ComponentFactory, Compression, CompressionType, ConflictError, Converter, ErrorHelper, Factory, FilenameHelper, GeneralError, GuardError, Guards, HexHelper, I18n, Is, JsonHelper, NotFoundError, NotImplementedError, NotSupportedError, ObjectHelper, RandomHelper, StringHelper, UnauthorizedError, UnprocessableError, Url, Urn, Validation, ValidationError };
+export { AlreadyExistsError, ArrayHelper, AsyncCache, Base32, Base58, Base64, Base64Url, BaseError, BitString, Coerce, CoerceType, ComponentFactory, Compression, CompressionType, ConflictError, Converter, EnvHelper, ErrorHelper, Factory, FilenameHelper, GeneralError, GuardError, Guards, HexHelper, I18n, Is, JsonHelper, NotFoundError, NotImplementedError, NotSupportedError, ObjectHelper, RandomHelper, StringHelper, UnauthorizedError, UnprocessableError, Url, Urn, Validation, ValidationError };