@twin.org/core 0.0.1-next.9 → 0.0.2-next.3

package/dist/types/errors/baseError.d.ts

@@ -95,9 +95,16 @@ export declare class BaseError extends Error implements IError {
      * @returns True if the error has the name.
      */
     static someErrorCode(error: unknown, code: string | RegExp): error is BaseError;
+    /**
+     * Is the error empty.
+     * @param err The error to check for being empty.
+     * @returns True if the error is empty.
+     */
+    static isEmpty(err: IError): boolean;
     /**
      * Serialize the error to the error model.
+     * @param includeStackTrace Whether to include the error stack in the model, defaults to false.
      * @returns The error model.
      */
-    toJsonObject(): IError;
+    toJsonObject(includeStackTrace?: boolean): IError;
 }

package/dist/types/factories/factory.d.ts

@@ -10,6 +10,21 @@ export declare class Factory<T> {
      * @returns The factory instance.
      */
     static createFactory<U>(typeName: string, autoInstance?: boolean, matcher?: (names: string[], name: string) => string | undefined): Factory<U>;
+    /**
+     * Get all the factories.
+     * @returns All the factories.
+     */
+    static getFactories(): {
+        [typeName: string]: Factory<unknown>;
+    };
+    /**
+     * Reset all the factories, which removes any created instances, but not the registrations.
+     */
+    static resetFactories(): void;
+    /**
+     * Clear all the factories, which removes anything registered with the factories.
+     */
+    static clearFactories(): void;
     /**
      * Register a new generator.
      * @param name The name of the generator.
@@ -38,9 +53,13 @@ export declare class Factory<T> {
      */
     getIfExists<U extends T>(name: string): U | undefined;
     /**
-     * Reset all the instances.
+     * Remove all the instances and leave the generators intact.
      */
     reset(): void;
+    /**
+     * Remove all the instances and the generators.
+     */
+    clear(): void;
     /**
      * Get all the instances as a map.
      * @returns The instances as a map.

package/dist/types/helpers/arrayHelper.d.ts

@@ -1,3 +1,4 @@
+import type { ObjectOrArray } from "../models/objectOrArray";
 /**
  * Class to help with arrays.
  */
@@ -9,4 +10,16 @@ export declare class ArrayHelper {
      * @returns True if both arrays are empty of have the same values.
      */
     static matches(arr1: unknown, arr2: unknown): boolean;
+    /**
+     * Convert an object or array to an array.
+     * @param value The object or array to convert.
+     * @returns The array.
+     */
+    static fromObjectOrArray<T = unknown>(value: undefined): undefined;
+    /**
+     * Convert an object or array to an array.
+     * @param value The object or array to convert.
+     * @returns The array.
+     */
+    static fromObjectOrArray<T = unknown>(value: ObjectOrArray<T>): T[];
 }

package/dist/types/helpers/envHelper.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Environment variable helper.
+ */
+export declare 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<T = {
+        [id: string]: string;
+    }>(envVars: {
+        [id: string]: string | undefined;
+    }, prefix?: string): T;
+}

package/dist/types/helpers/errorHelper.d.ts

@@ -6,9 +6,10 @@ export declare class ErrorHelper {
     /**
      * Format Errors and returns just their messages.
      * @param error The error to format.
+     * @param includeDetails Whether to include error details, defaults to false.
      * @returns The error formatted including any inner errors.
      */
-    static formatErrors(error: unknown): string[];
+    static formatErrors(error: unknown, includeDetails?: boolean): string[];
     /**
      * Localize the content of an error and any inner errors.
      * @param error The error to format.

package/dist/types/helpers/jsonHelper.d.ts

@@ -24,6 +24,36 @@ export declare class JsonHelper {
      * @param object The object to patch.
      * @param patches The second object.
      * @returns The updated object.
+     * @throws GeneralError if the patch fails.
      */
     static patch<T = unknown>(object: T, patches: IPatchOperation[]): T;
+    /**
+     * 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 stringifyEx(object: any, space?: string | number): string;
+    /**
+     * 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: string): any;
+    /**
+     * Replacer function to handle extended data types.
+     * @param this The object.
+     * @param key The key.
+     * @param value The value.
+     * @returns The value.
+     */
+    static stringifyExReplacer(this: any, key: string, value: unknown): unknown;
+    /**
+     * Reviver function to handle extended data types.
+     * @param this The object.
+     * @param key The key.
+     * @param value The value.
+     * @returns The value.
+     */
+    static parseExReviver(this: any, key: string, value: unknown): unknown;
 }

package/dist/types/helpers/objectHelper.d.ts

@@ -49,6 +49,7 @@ export declare class ObjectHelper {
      * @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 propertySet(obj: unknown, property: string, value: unknown): void;
     /**
@@ -79,4 +80,28 @@ export declare class ObjectHelper {
      * @returns The partial object.
      */
     static omit<T>(obj: T | undefined, keys?: (keyof T)[]): Partial<T>;
+    /**
+     * Converter the non JSON primitives to extended types.
+     * @param obj The object to convert.
+     * @returns The object with extended properties.
+     */
+    static toExtended(obj: any): any;
+    /**
+     * Converter the extended types to non JSON primitives.
+     * @param obj The object to convert.
+     * @returns The object with regular properties.
+     */
+    static fromExtended(obj: any): any;
+    /**
+     * Remove empty properties from an object.
+     * @param obj The object to remove the empty properties from.
+     * @param options The options for the removal.
+     * @param options.removeUndefined Remove undefined properties, defaults to true.
+     * @param options.removeNull Remove null properties, defaults to false.
+     * @returns The object with empty properties removed.
+     */
+    static removeEmptyProperties<T = unknown>(obj: T, options?: {
+        removeUndefined?: boolean;
+        removeNull?: boolean;
+    }): T;
 }

package/dist/types/helpers/uint8ArrayHelper.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Class to help with uint8 arrays.
+ */
+export declare class Uint8ArrayHelper {
+    /**
+     * Concatenate multiple arrays.
+     * @param arrays The array to concatenate.
+     * @returns The combined array.
+     */
+    static concat(arrays: Uint8Array[]): Uint8Array;
+}

package/dist/types/index.d.ts

@@ -16,6 +16,7 @@ export * from "./errors/validationError";
 export * from "./factories/componentFactory";
 export * from "./factories/factory";
 export * from "./helpers/arrayHelper";
+export * from "./helpers/envHelper";
 export * from "./helpers/errorHelper";
 export * from "./helpers/filenameHelper";
 export * from "./helpers/hexHelper";
@@ -23,9 +24,12 @@ export * from "./helpers/jsonHelper";
 export * from "./helpers/objectHelper";
 export * from "./helpers/randomHelper";
 export * from "./helpers/stringHelper";
+export * from "./helpers/uint8ArrayHelper";
+export * from "./models/coerceType";
 export * from "./models/compressionType";
 export * from "./models/IComponent";
 export * from "./models/IError";
+export * from "./models/II18nShared";
 export * from "./models/IKeyValue";
 export * from "./models/ILabelledValue";
 export * from "./models/ILocale";
@@ -34,6 +38,7 @@ export * from "./models/ILocalesIndex";
 export * from "./models/IPatchOperation";
 export * from "./models/IUrlParts";
 export * from "./models/IValidationFailure";
+export * from "./models/objectOrArray";
 export * from "./types/bitString";
 export * from "./types/url";
 export * from "./types/urn";
@@ -44,4 +49,5 @@ export * from "./utils/converter";
 export * from "./utils/guards";
 export * from "./utils/i18n";
 export * from "./utils/is";
+export * from "./utils/sharedStore";
 export * from "./utils/validation";

package/dist/types/models/IComponent.d.ts

@@ -9,21 +9,30 @@ export interface IComponent {
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
      * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param componentState A persistent state which can be modified by the method.
      * @returns True if the bootstrapping process was successful.
      */
-    bootstrap?(nodeLoggingConnectorType?: string): Promise<boolean>;
+    bootstrap?(nodeLoggingConnectorType: string | undefined, componentState?: {
+        [id: string]: unknown;
+    }): Promise<boolean>;
     /**
      * The component needs to be started when the node is initialized.
      * @param nodeIdentity The identity of the node starting the component.
      * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param componentState A persistent state which can be modified by the method.
      * @returns Nothing.
      */
-    start?(nodeIdentity: string, nodeLoggingConnectorType?: string): Promise<void>;
+    start?(nodeIdentity: string, nodeLoggingConnectorType: string | undefined, componentState?: {
+        [id: string]: unknown;
+    }): Promise<void>;
     /**
      * The component needs to be stopped when the node is closed.
      * @param nodeIdentity The identity of the node stopping the component.
      * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param componentState A persistent state which can be modified by the method.
      * @returns Nothing.
      */
-    stop?(nodeIdentity: string, nodeLoggingConnectorType?: string): Promise<void>;
+    stop?(nodeIdentity: string, nodeLoggingConnectorType: string | undefined, componentState?: {
+        [id: string]: unknown;
+    }): Promise<void>;
 }

package/dist/types/models/II18nShared.d.ts

@@ -0,0 +1,29 @@
+/**
+ * The shared state for the I18n global.
+ */
+export interface II18nShared {
+    /**
+     * Dictionaries for lookups.
+     */
+    localeDictionaries: {
+        [locale: string]: {
+            [key: string]: string;
+        };
+    };
+    /**
+     * The current locale.
+     */
+    currentLocale: string;
+    /**
+     * Change handler for the locale being updated.
+     */
+    localeChangedHandlers: {
+        [id: string]: (locale: string) => void;
+    };
+    /**
+     * Change handler for the dictionaries being updated.
+     */
+    dictionaryChangedHandlers: {
+        [id: string]: (locale: string) => void;
+    };
+}

package/dist/types/models/coerceType.d.ts

@@ -0,0 +1,49 @@
+/**
+ * The types the extracted data can be coerced to.
+ */
+export declare const CoerceType: {
+    /**
+     * String.
+     */
+    readonly String: "string";
+    /**
+     * Number.
+     */
+    readonly Number: "number";
+    /**
+     * Integer.
+     */
+    readonly Integer: "integer";
+    /**
+     * Boolean.
+     */
+    readonly Boolean: "boolean";
+    /**
+     * Big Integer.
+     */
+    readonly BigInt: "bigint";
+    /**
+     * Date.
+     */
+    readonly Date: "date";
+    /**
+     * Date Time.
+     */
+    readonly DateTime: "datetime";
+    /**
+     * Time.
+     */
+    readonly Time: "time";
+    /**
+     * Object.
+     */
+    readonly Object: "object";
+    /**
+     * Uint8Array.
+     */
+    readonly Uint8Array: "uint8array";
+};
+/**
+ * The types the extracted data can be coerced to.
+ */
+export type CoerceType = (typeof CoerceType)[keyof typeof CoerceType];

package/dist/types/models/compressionType.d.ts

@@ -7,7 +7,7 @@ export declare const CompressionType: {
      */
     readonly Gzip: "gzip";
     /**
-     * deflate.
+     * Deflate.
      */
     readonly Deflate: "deflate";
 };

package/dist/types/models/objectOrArray.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Object or array data type
+ */
+export type ObjectOrArray<T = unknown> = T | T[];

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

@@ -7,15 +7,24 @@ export declare class AsyncCache {
      * @param key The key for the entry in the cache.
      * @param ttlMs The TTL of the entry in the cache.
      * @param requestMethod The method to call if not cached.
+     * @param cacheFailures Cache failure results, defaults to false.
      * @returns The response.
      */
-    static exec<T = unknown>(key: string, ttlMs: number | undefined, requestMethod: () => Promise<T>): Promise<T> | undefined;
+    static exec<T = unknown>(key: string, ttlMs: number | undefined, requestMethod: () => Promise<T>, cacheFailures?: boolean): Promise<T> | undefined;
     /**
      * Get an entry from the cache.
      * @param key The key to get from the cache.
      * @returns The item from the cache if it exists.
      */
     static get<T = unknown>(key: string): Promise<T | undefined>;
+    /**
+     * Set an entry into the cache.
+     * @param key The key to set in the cache.
+     * @param value The value to set in the cache.
+     * @param ttlMs The TTL of the entry in the cache in ms, defaults to 1s.
+     * @returns Nothing.
+     */
+    static set<T = unknown>(key: string, value: T, ttlMs?: number): Promise<void>;
     /**
      * Remove an entry from the cache.
      * @param key The key to remove from the cache.

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

@@ -1,3 +1,4 @@
+import { CoerceType } from "../models/coerceType";
 /**
  * Coerce an object from one type to another.
  */
@@ -16,6 +17,13 @@ export declare class Coerce {
      * @returns The value if it can be coerced.
      */
     static number(value: unknown): number | undefined;
+    /**
+     * 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 integer(value: unknown): number | undefined;
     /**
      * Coerce the value to a bigint.
      * @param value The value to coerce.
@@ -58,4 +66,18 @@ export declare class Coerce {
      * @returns The value if it can be coerced.
      */
     static object<T = unknown>(value: unknown): T | undefined;
+    /**
+     * 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 uint8Array(value: unknown): Uint8Array | undefined;
+    /**
+     * 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: unknown, type?: CoerceType): unknown;
 }

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

@@ -1,3 +1,4 @@
+import type { ObjectOrArray } from "../models/objectOrArray";
 /**
  * Class to handle guard operations for parameters.
  */
@@ -26,6 +27,14 @@ export declare class Guards {
      * @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 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: string, property: string, value: unknown): asserts value is string;
     /**
      * Is the property a base64 string.
      * @param source The source of the error.
@@ -42,6 +51,14 @@ export declare class Guards {
      * @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 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: 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.
@@ -162,6 +179,24 @@ export declare class Guards {
      * @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;
+    /**
+     * Does the array start with the specified data.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param startValues The values that must start the array.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static arrayStartsWith<T>(source: string, property: string, value: unknown, startValues: ObjectOrArray<T>): asserts value is T[];
+    /**
+     * Does the array end with the specified data.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param endValues The values that must end the array.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static arrayEndsWith<T>(source: string, property: string, value: unknown, endValues: ObjectOrArray<T>): asserts value is T[];
     /**
      * Is the property a Uint8Array.
      * @param source The source of the error.

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

@@ -56,6 +56,12 @@ export declare class Is {
      * @returns True if the value is a base64 string.
      */
     static stringBase64Url(value: unknown): value is string;
+    /**
+     * Is the value a base58 string.
+     * @param value The value to test.
+     * @returns True if the value is a base58 string.
+     */
+    static stringBase58(value: unknown): value is string;
     /**
      * Is the value a hex string.
      * @param value The value to test.
@@ -202,4 +208,10 @@ export declare class Is {
      * @returns True if the value is a promise.
      */
     static promise<T = unknown>(value: unknown): value is Promise<T>;
+    /**
+     * Is the value a regexp.
+     * @param value The value to test.
+     * @returns True if the value is a regexp.
+     */
+    static regexp(value: unknown): value is RegExp;
 }

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

@@ -0,0 +1,23 @@
+/**
+ * Provide a store for shared objects which can be accesses through multiple
+ * instance loads of a packages.
+ */
+export declare class SharedStore {
+    /**
+     * Get a property from the shared store.
+     * @param prop The name of the property to get.
+     * @returns The property if it exists.
+     */
+    static get<T = unknown>(prop: string): T | undefined;
+    /**
+     * Set the property in the shared store.
+     * @param prop The name of the property to set.
+     * @param value The value to set.
+     */
+    static set<T = unknown>(prop: string, value: T): void;
+    /**
+     * Remove a property from the shared store.
+     * @param prop The name of the property to remove.
+     */
+    static remove(prop: string): void;
+}

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

@@ -30,9 +30,11 @@ export declare 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: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string, options?: {
+        format?: "base64" | "base58" | "hex" | RegExp;
         minLength?: number;
         maxLength?: number;
     }): value is string;