@twin.org/core 0.0.1-next.1

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

@@ -0,0 +1,245 @@
+import type { IValidationFailure } from "../models/IValidationFailure";
+/**
+ * Class to handle validation operations.
+ */
+export declare class Validation {
+    /**
+     * Is the property null or undefined.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is a empty.
+     */
+    static empty(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is undefined | null;
+    /**
+     * Is the property is not null or undefined.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is a not empty.
+     */
+    static notEmpty(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): boolean;
+    /**
+     * Is the property a string.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @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.
+     * @returns True if the value is a valid string.
+     */
+    static string(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string, options?: {
+        minLength?: number;
+        maxLength?: number;
+    }): value is string;
+    /**
+     * Is the property a string with a value.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @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.
+     * @returns True if the value is a valid string.
+     */
+    static stringValue(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string, options?: {
+        minLength?: number;
+        maxLength?: number;
+    }): value is string;
+    /**
+     * Is the property a number.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @param options Additional options for the validation.
+     * @param options.minValue The minimum value of the number.
+     * @param options.maxValue The maximum value of the number.
+     * @returns True if the value is a valid number.
+     */
+    static number(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string, options?: {
+        minValue?: number;
+        maxValue?: number;
+    }): value is number;
+    /**
+     * Is the property an integer.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @param options Additional options for the validation.
+     * @param options.minValue The minimum value of the integer.
+     * @param options.maxValue The maximum value of the integer.
+     * @returns True if the value is a valid integer.
+     */
+    static integer(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string, options?: {
+        minValue?: number;
+        maxValue?: number;
+    }): value is number;
+    /**
+     * Is the property a bigint.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @param options Additional options for the validation.
+     * @param options.minValue The minimum value of the bigint.
+     * @param options.maxValue The maximum value of the bigint.
+     * @returns True if the value is a valid bigint.
+     */
+    static bigint(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string, options?: {
+        minValue?: bigint;
+        maxValue?: bigint;
+    }): value is bigint;
+    /**
+     * Is the property a boolean.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is a boolean.
+     */
+    static boolean(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is boolean;
+    /**
+     * Is the property a date.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is a date.
+     */
+    static date(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is Date;
+    /**
+     * Is the property a date in ISO 8601 format.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is a date.
+     */
+    static dateString(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is string;
+    /**
+     * Is the property a date/time in ISO 8601 format.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is a date/time.
+     */
+    static dateTimeString(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is string;
+    /**
+     * Is the property a time in ISO 8601 format.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is a time.
+     */
+    static timeString(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is string;
+    /**
+     * Is the property a timestamp in milliseconds.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is a timestamp in milliseconds.
+     */
+    static timestampMilliseconds(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is number;
+    /**
+     * Is the property a timestamp in seconds.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is a timestamp in seconds.
+     */
+    static timestampSeconds(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is number;
+    /**
+     * Is the property an object.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is a object.
+     */
+    static object<T = {
+        [id: string]: unknown;
+    }>(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is T;
+    /**
+     * Is the property an array.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is an array.
+     */
+    static array<T>(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is T[];
+    /**
+     * Is the property an array with at least one item.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is an array with at least one element.
+     */
+    static arrayValue<T>(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is T[];
+    /**
+     * Is the property one of a list of items.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param options The options the value must be one of.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is one of the items in the options.
+     */
+    static arrayOneOf<T>(property: string, value: T, options: T[], failures: IValidationFailure[], fieldNameResource?: string): value is T;
+    /**
+     * Is the property a Uint8Array.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is a Uint8Array.
+     */
+    static uint8Array(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is Uint8Array;
+    /**
+     * Is the property valid JSON.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is valid JSON.
+     */
+    static json(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is string;
+    /**
+     * Is the property a string in e-mail format.
+     * @param property The name of the property.
+     * @param value The value to test.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource Optional i18n resource of the field name to display in the message.
+     * @returns True if the value is a valid looking e-mail.
+     */
+    static email(property: string, value: unknown, failures: IValidationFailure[], fieldNameResource?: string): value is string;
+    /**
+     * Throw the validation failures as a ValidationError.
+     * @param source The source of the error.
+     * @param objectName The object that was being validated.
+     * @param failures The validation failures.
+     * @throws ValidationError From the converted failures.
+     */
+    static asValidationError(source: string, objectName: string, failures: IValidationFailure[]): void;
+    /**
+     * Map a list of failures to their properties in a map.
+     * @param failures The validation failures to combine into the map for the properties.
+     * @param propertyMap The map to add the failures to.
+     * @param clearMap Should the map be cleared before adding the failures.
+     */
+    static toPropertyMap(failures: IValidationFailure[], propertyMap: {
+        [property: string]: IValidationFailure[];
+    }, clearMap?: boolean): void;
+}

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/core - Changelog
+
+## v0.0.1
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/core - Examples

package/docs/reference/classes/AlreadyExistsError.md

@@ -0,0 +1,375 @@
+# Class: AlreadyExistsError
+
+Class to handle errors which are triggered by data already existing.
+
+## Extends
+
+- [`BaseError`](BaseError.md)
+
+## Constructors
+
+### new AlreadyExistsError()
+
+> **new AlreadyExistsError**(`source`, `message`, `existingId`?, `inner`?): [`AlreadyExistsError`](AlreadyExistsError.md)
+
+Create a new instance of AlreadyExistsError.
+
+#### Parameters
+
+• **source**: `string`
+
+The source of the error.
+
+• **message**: `string`
+
+The message as a code.
+
+• **existingId?**: `string`
+
+The id for the item.
+
+• **inner?**: `unknown`
+
+The inner error if we have wrapped another error.
+
+#### Returns
+
+[`AlreadyExistsError`](AlreadyExistsError.md)
+
+#### Overrides
+
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+***
+
+### source?
+
+> `optional` **source**: `string`
+
+The source of the error.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`source`](BaseError.md#source)
+
+***
+
+### properties?
+
+> `optional` **properties**: `object`
+
+Any additional information for the error.
+
+#### Index Signature
+
+ \[`id`: `string`\]: `unknown`
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties)
+
+***
+
+### inner?
+
+> `optional` **inner**: [`IError`](../interfaces/IError.md)
+
+The inner error if there was one.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
+
+## Methods
+
+### fromError()
+
+> `static` **fromError**(`err`): [`BaseError`](BaseError.md)
+
+Construct an error from an existing one.
+
+#### Parameters
+
+• **err**: `unknown`
+
+The existing error.
+
+#### Returns
+
+[`BaseError`](BaseError.md)
+
+The new instance.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`fromError`](BaseError.md#fromerror)
+
+***
+
+### flatten()
+
+> `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
+
+Flatten an error tree.
+
+#### Parameters
+
+• **err**: `unknown`
+
+The starting error.
+
+#### Returns
+
+[`IError`](../interfaces/IError.md)[]
+
+The list of all internal errors.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`flatten`](BaseError.md#flatten)
+
+***
+
+### expand()
+
+> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+
+Expand an error tree.
+
+#### Parameters
+
+• **errors**: `undefined` \| [`IError`](../interfaces/IError.md)[]
+
+The list of errors to expand.
+
+#### Returns
+
+`undefined` \| [`IError`](../interfaces/IError.md)
+
+The first level error.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`expand`](BaseError.md#expand)
+
+***
+
+### isErrorName()
+
+> `static` **isErrorName**(`error`, `name`): `error is BaseError`
+
+Test to see if the error has the specified error name.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **name**: `string` \| `RegExp`
+
+The name to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the name.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`isErrorName`](BaseError.md#iserrorname)
+
+***
+
+### isErrorMessage()
+
+> `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
+
+Test to see if the error has the specified error message.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **message**: `string` \| `RegExp`
+
+The message to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the name.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`isErrorMessage`](BaseError.md#iserrormessage)
+
+***
+
+### isErrorCode()
+
+> `static` **isErrorCode**(`error`, `code`): `boolean`
+
+Test to see if the error has the specified error code.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **code**: `string` \| `RegExp`
+
+The code to check for.
+
+#### Returns
+
+`boolean`
+
+True if the error has the code.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`isErrorCode`](BaseError.md#iserrorcode)
+
+***
+
+### someErrorName()
+
+> `static` **someErrorName**(`error`, `name`): `error is BaseError`
+
+Test to see if any of the errors or children have the given error name.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **name**: `string` \| `RegExp`
+
+The name to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the name.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`someErrorName`](BaseError.md#someerrorname)
+
+***
+
+### someErrorMessage()
+
+> `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
+
+Test to see if any of the errors or children have the given error message.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **message**: `string` \| `RegExp`
+
+The message to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the name.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`someErrorMessage`](BaseError.md#someerrormessage)
+
+***
+
+### someErrorClass()
+
+> `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
+
+Test to see if any of the errors or children are from a specific class.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **cls**: `string`
+
+The class to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the specific class.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`someErrorClass`](BaseError.md#someerrorclass)
+
+***
+
+### someErrorCode()
+
+> `static` **someErrorCode**(`error`, `code`): `error is BaseError`
+
+Test to see if any of the errors or children have the given error code.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **code**: `string` \| `RegExp`
+
+The code to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the name.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`someErrorCode`](BaseError.md#someerrorcode)
+
+***
+
+### toJsonObject()
+
+> **toJsonObject**(): [`IError`](../interfaces/IError.md)
+
+Serialize the error to the error model.
+
+#### Returns
+
+[`IError`](../interfaces/IError.md)
+
+The error model.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`toJsonObject`](BaseError.md#tojsonobject)

package/docs/reference/classes/ArrayHelper.md

@@ -0,0 +1,37 @@
+# Class: ArrayHelper
+
+Class to help with arrays.
+
+## Constructors
+
+### new ArrayHelper()
+
+> **new ArrayHelper**(): [`ArrayHelper`](ArrayHelper.md)
+
+#### Returns
+
+[`ArrayHelper`](ArrayHelper.md)
+
+## Methods
+
+### matches()
+
+> `static` **matches**(`arr1`, `arr2`): `boolean`
+
+Do the two arrays match.
+
+#### Parameters
+
+• **arr1**: `unknown`
+
+The first array.
+
+• **arr2**: `unknown`
+
+The second array.
+
+#### Returns
+
+`boolean`
+
+True if both arrays are empty of have the same values.