@twin.org/core 0.0.1-next.1

package/dist/types/utils/converter.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Convert arrays to and from different formats.
+ */
+export declare class Converter {
+    /**
+     * 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: ArrayLike<number>, startIndex?: number, length?: number | undefined): string;
+    /**
+     * Convert a UTF8 string to raw array.
+     * @param utf8 The text to decode.
+     * @returns The array.
+     */
+    static utf8ToBytes(utf8: string): Uint8Array;
+    /**
+     * 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: ArrayLike<number>, includePrefix?: boolean, startIndex?: number, length?: number | undefined, reverse?: boolean): string;
+    /**
+     * 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: string, reverse?: boolean): Uint8Array;
+    /**
+     * 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: string, includePrefix?: boolean): string;
+    /**
+     * Convert the hex text to text.
+     * @param hex The hex to convert.
+     * @returns The UTF8 version of the bytes.
+     */
+    static hexToUtf8(hex: string): string;
+    /**
+     * Convert bytes to binary string.
+     * @param bytes The bytes to convert.
+     * @returns A binary string of the bytes.
+     */
+    static bytesToBinary(bytes: Uint8Array): string;
+    /**
+     * Convert a binary string to bytes.
+     * @param binary The binary string.
+     * @returns The bytes.
+     */
+    static binaryToBytes(binary: string): Uint8Array;
+    /**
+     * Convert bytes to base64 string.
+     * @param bytes The bytes to convert.
+     * @returns A base64 string of the bytes.
+     */
+    static bytesToBase64(bytes: Uint8Array): string;
+    /**
+     * Convert a base64 string to bytes.
+     * @param base64 The base64 string.
+     * @returns The bytes.
+     */
+    static base64ToBytes(base64: string): Uint8Array;
+    /**
+     * Convert bytes to base64 url string.
+     * @param bytes The bytes to convert.
+     * @returns A base64 url string of the bytes.
+     */
+    static bytesToBase64Url(bytes: Uint8Array): string;
+    /**
+     * Convert a base64 url string to bytes.
+     * @param base64Url The base64 url string.
+     * @returns The bytes.
+     */
+    static base64UrlToBytes(base64Url: string): Uint8Array;
+}

package/dist/types/utils/guards.d.ts

@@ -0,0 +1,190 @@
+/**
+ * Class to handle guard operations for parameters.
+ */
+export declare 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: string, property: string, value: unknown): asserts 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: string, property: string, value: unknown): asserts value is string;
+    /**
+     * 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: string, property: string, value: unknown): asserts value is string;
+    /**
+     * 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: string, property: string, value: unknown): asserts value is string;
+    /**
+     * 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: string, property: string, value: unknown): asserts value is string;
+    /**
+     * 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: string, property: string, value: unknown, allowPrefix?: boolean): asserts value is string;
+    /**
+     * 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: string, property: string, value: unknown, length: number, allowPrefix?: boolean): asserts value is string;
+    /**
+     * 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: string, property: string, value: unknown): asserts value is number;
+    /**
+     * 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: string, property: string, value: unknown): asserts value is number;
+    /**
+     * 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: string, property: string, value: unknown): asserts value is bigint;
+    /**
+     * 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: string, property: string, value: unknown): asserts value is boolean;
+    /**
+     * 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: string, property: string, value: unknown): asserts value is Date;
+    /**
+     * 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: string, property: string, value: unknown): asserts value is number;
+    /**
+     * 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: string, property: string, value: unknown): asserts value is number;
+    /**
+     * 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<T = {
+        [id: string]: unknown;
+    }>(source: string, property: string, value: unknown): asserts value is T;
+    /**
+     * 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<T = {
+        [id: string]: unknown;
+    }>(source: string, property: string, value: unknown): asserts value is T;
+    /**
+     * 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<T>(source: string, property: string, value: unknown): asserts value is T[];
+    /**
+     * 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<T>(source: string, property: string, value: unknown): asserts value is T[];
+    /**
+     * 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<T>(source: string, property: string, value: T, options: T[]): asserts value is T;
+    /**
+     * 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: string, property: string, value: unknown): asserts value is Uint8Array;
+    /**
+     * 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.
+     * @returns True if the value is a function.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static function(source: string, property: string, value: unknown): boolean;
+    /**
+     * 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: string, property: string, value: unknown): asserts value is string;
+}

package/dist/types/utils/i18n.d.ts

@@ -0,0 +1,81 @@
+import type { ILocaleDictionary } from "../models/ILocaleDictionary";
+/**
+ * Class to perform internationalization.
+ */
+export declare class I18n {
+    /**
+     * The default translation.
+     */
+    static DEFAULT_LOCALE: string;
+    /**
+     * Set the locale.
+     * @param locale The new locale.
+     */
+    static setLocale(locale: string): void;
+    /**
+     * Get the locale.
+     * @returns The current locale.
+     */
+    static getLocale(): string;
+    /**
+     * Add a locale dictionary.
+     * @param locale The locale.
+     * @param dictionary The dictionary to add.
+     */
+    static addDictionary(locale: string, dictionary: ILocaleDictionary): void;
+    /**
+     * Get a locale dictionary.
+     * @param locale The locale.
+     * @returns The dictionary of undefined if it does not exist.
+     */
+    static getDictionary(locale: string): {
+        [key: string]: string;
+    } | undefined;
+    /**
+     * Get all the locale dictionaries.
+     * @returns The dictionaries.
+     */
+    static getAllDictionaries(): {
+        [locale: string]: {
+            [key: string]: string;
+        };
+    };
+    /**
+     * Add a locale changed handler.
+     * @param id The id of the handler.
+     * @param handler The handler to add.
+     */
+    static addLocaleHandler(id: string, handler: (locale: string) => void): void;
+    /**
+     * Remove a locale changed handler.
+     * @param id The id of the handler.
+     */
+    static removeLocaleHandler(id: string): void;
+    /**
+     * Add a dictionary changed handler.
+     * @param id The id of the handler.
+     * @param handler The handler to add.
+     */
+    static addDictionaryHandler(id: string, handler: (locale: string) => void): void;
+    /**
+     * Remove a dictionary changed handler.
+     * @param id The id of the handler.
+     */
+    static removeDictionaryHandler(id: string): void;
+    /**
+     * 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: string, values?: {
+        [key: string]: unknown;
+    }, overrideLocale?: string): string;
+    /**
+     * 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: string): boolean;
+}

package/dist/types/utils/is.d.ts

@@ -0,0 +1,205 @@
+/**
+ * Class to check types of objects.
+ */
+export declare class Is {
+    /**
+     * Is the property undefined.
+     * @param value The value to test.
+     * @returns True if the value is a empty.
+     */
+    static undefined(value: unknown): value is undefined;
+    /**
+     * Is the property null.
+     * @param value The value to test.
+     * @returns True if the value is a empty.
+     */
+    static null(value: unknown): value is null;
+    /**
+     * Is the property null or undefined.
+     * @param value The value to test.
+     * @returns True if the value is a empty.
+     */
+    static empty(value: unknown): value is undefined | null;
+    /**
+     * Is the property is not null or undefined.
+     * @param value The value to test.
+     * @returns True if the value is a not empty.
+     */
+    static notEmpty(value: unknown): boolean;
+    /**
+     * Is the value a string.
+     * @param value The value to test.
+     * @returns True if the value is a string.
+     */
+    static string(value: unknown): value is string;
+    /**
+     * Is the value a string.
+     * @param value The value to test.
+     * @returns True if the value is a string.
+     */
+    static stringValue(value: unknown): value is string;
+    /**
+     * Is the value a JSON string.
+     * @param value The value to test.
+     * @returns True if the value is a JSON string.
+     */
+    static json(value: unknown): value is string;
+    /**
+     * Is the value a base64 string.
+     * @param value The value to test.
+     * @returns True if the value is a base64 string.
+     */
+    static stringBase64(value: unknown): value is string;
+    /**
+     * Is the value a base64 url string.
+     * @param value The value to test.
+     * @returns True if the value is a base64 string.
+     */
+    static stringBase64Url(value: unknown): value is string;
+    /**
+     * Is the value a hex string.
+     * @param value The value to test.
+     * @param allowPrefix Allow the hex to have the 0x prefix.
+     * @returns True if the value is a hex string.
+     */
+    static stringHex(value: unknown, allowPrefix?: boolean): value is string;
+    /**
+     * Is the value a hex string of fixed length.
+     * @param value The value to test.
+     * @param length The length to test.
+     * @param allowPrefix Allow the hex to have the 0x prefix.
+     * @returns True if the value is a hex string of required length.
+     */
+    static stringHexLength(value: unknown, length: number, allowPrefix?: boolean): value is string;
+    /**
+     * Is the value a number.
+     * @param value The value to test.
+     * @returns True if the value is a number.
+     */
+    static number(value: unknown): value is number;
+    /**
+     * Is the value an integer.
+     * @param value The value to test.
+     * @returns True if the value is an integer.
+     */
+    static integer(value: unknown): value is number;
+    /**
+     * Is the value a big integer.
+     * @param value The value to test.
+     * @returns True if the value is a big integer.
+     */
+    static bigint(value: unknown): value is bigint;
+    /**
+     * Is the value a boolean.
+     * @param value The value to test.
+     * @returns True if the value is a boolean.
+     */
+    static boolean(value: unknown): value is boolean;
+    /**
+     * Is the value a date.
+     * @param value The value to test.
+     * @returns True if the value is a date.
+     */
+    static date(value: unknown): value is Date;
+    /**
+     * Is the value an empty date.
+     * @param value The value to test.
+     * @returns True if the value is an empty date.
+     */
+    static dateEmpty(value: unknown): boolean;
+    /**
+     * Is the value a date string.
+     * @param value The value to test.
+     * @returns True if the value is a string in ISO 8601 date format.
+     */
+    static dateString(value: unknown): boolean;
+    /**
+     * Is the value a date string.
+     * @param value The value to test.
+     * @returns True if the value is a string in ISO 8601 date/time format.
+     */
+    static dateTimeString(value: unknown): boolean;
+    /**
+     * Is the value a time string.
+     * @param value The value to test.
+     * @returns True if the value is a string in ISO 8601 time format.
+     */
+    static timeString(value: unknown): boolean;
+    /**
+     * Is the value a timestamp in seconds.
+     * @param value The value to test.
+     * @returns True if the value is a date.
+     */
+    static timestampSeconds(value: unknown): value is number;
+    /**
+     * Is the value a timestamp in milliseconds.
+     * @param value The value to test.
+     * @returns True if the value is a date.
+     */
+    static timestampMilliseconds(value: unknown): value is number;
+    /**
+     * Is the value an object.
+     * @param value The value to test.
+     * @returns True if the value is a object.
+     */
+    static object<T = {
+        [id: string]: unknown;
+    }>(value: unknown): value is T;
+    /**
+     * Is the value an object with at least one property.
+     * @param value The value to test.
+     * @returns True if the value is a object.
+     */
+    static objectValue<T = {
+        [id: string]: unknown;
+    }>(value: unknown): value is T;
+    /**
+     * Is the value an array.
+     * @param value The value to test.
+     * @returns True if the value is an array.
+     */
+    static array<T>(value: unknown): value is T[];
+    /**
+     * Is the value an array with at least one element.
+     * @param value The value to test.
+     * @returns True if the value is an array with at least one element.
+     */
+    static arrayValue<T>(value: unknown): value is T[];
+    /**
+     * Is the value an array with at least one element.
+     * @param value The value to test.
+     * @param options The options the value must be one of.
+     * @returns True if the value is an element from the options array.
+     */
+    static arrayOneOf<T>(value: T, options: T[]): value is T;
+    /**
+     * Is the value a Uint8Array.
+     * @param value The value to test.
+     * @returns True if the value is a Uint8Array.
+     */
+    static uint8Array(value: unknown): value is Uint8Array;
+    /**
+     * Is the value a TypedArray.
+     * @param value The value to test.
+     * @returns True if the value is a TypedArray.
+     */
+    static typedArray(value: unknown): value is Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | Float32Array | Float64Array;
+    /**
+     * Is the property a function.
+     * @param value The value to test.
+     * @returns True if the value is a function.
+     */
+    static function(value: unknown): value is (...args: unknown[]) => unknown;
+    /**
+     * Is the value a string formatted as an email address.
+     * @param value The value to test.
+     * @returns True if the value is a string.
+     */
+    static email(value: unknown): value is string;
+    /**
+     * Is the value a promise.
+     * @param value The value to test.
+     * @returns True if the value is a promise.
+     */
+    static promise<T = unknown>(value: unknown): value is Promise<T>;
+}