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

package/docs/reference/classes/ValidationError.md

@@ -8,33 +8,39 @@ Class to handle errors which are triggered by entity validation.
 
 ## Constructors
 
-### new ValidationError()
+### Constructor
 
-> **new ValidationError**(`source`, `validationObject`, `validationFailures`): [`ValidationError`](ValidationError.md)
+> **new ValidationError**(`source`, `validationObject`, `validationFailures`): `ValidationError`
 
 Create a new instance of ValidationError.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **validationObject**: `string`
+##### validationObject
+
+`string`
 
 The object that failed validation.
 
-• **validationFailures**: [`IValidationFailure`](../interfaces/IValidationFailure.md)[]
+##### validationFailures
+
+[`IValidationFailure`](../interfaces/IValidationFailure.md)[]
 
 The validation failures.
 
 #### Returns
 
-[`ValidationError`](ValidationError.md)
+`ValidationError`
 
 #### Overrides
 
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructor)
 
 ## Properties
 
@@ -58,7 +64,7 @@ Any additional information for the error.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 #### Inherited from
 
@@ -94,7 +100,9 @@ Construct an error from an existing one.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The existing error.
 
@@ -118,7 +126,9 @@ Flatten an error tree.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The starting error.
 
@@ -142,10 +152,12 @@ Expand an error tree.
 
 #### Parameters
 
-• **errors**: `undefined` \| [`IError`](../interfaces/IError.md)[]
+##### errors
 
 The list of errors to expand.
 
+`undefined` | [`IError`](../interfaces/IError.md)[]
+
 #### Returns
 
 `undefined` \| [`IError`](../interfaces/IError.md)
@@ -166,14 +178,18 @@ Test to see if the error has the specified error name.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **name**: `string` \| `RegExp`
+##### name
 
 The name to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `error is BaseError`
@@ -194,14 +210,18 @@ Test to see if the error has the specified error message.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **message**: `string` \| `RegExp`
+##### message
 
 The message to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `error is BaseError`
@@ -222,14 +242,18 @@ Test to see if the error has the specified error code.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **code**: `string` \| `RegExp`
+##### code
 
 The code to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `boolean`
@@ -250,14 +274,18 @@ Test to see if any of the errors or children have the given error name.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **name**: `string` \| `RegExp`
+##### name
 
 The name to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `error is BaseError`
@@ -278,14 +306,18 @@ Test to see if any of the errors or children have the given error message.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **message**: `string` \| `RegExp`
+##### message
 
 The message to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `error is BaseError`
@@ -306,11 +338,15 @@ Test to see if any of the errors or children are from a specific class.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **cls**: `string`
+##### cls
+
+`string`
 
 The class to check for.
 
@@ -334,14 +370,18 @@ Test to see if any of the errors or children have the given error code.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **code**: `string` \| `RegExp`
+##### code
 
 The code to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `error is BaseError`
@@ -354,12 +394,46 @@ True if the error has the name.
 
 ***
 
+### isEmpty()
+
+> `static` **isEmpty**(`err`): `boolean`
+
+Is the error empty.
+
+#### Parameters
+
+##### err
+
+[`IError`](../interfaces/IError.md)
+
+The error to check for being empty.
+
+#### Returns
+
+`boolean`
+
+True if the error is empty.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`isEmpty`](BaseError.md#isempty)
+
+***
+
 ### toJsonObject()
 
-> **toJsonObject**(): [`IError`](../interfaces/IError.md)
+> **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 
 Serialize the error to the error model.
 
+#### Parameters
+
+##### includeStackTrace?
+
+`boolean`
+
+Whether to include the error stack in the model, defaults to false.
+
 #### Returns
 
 [`IError`](../interfaces/IError.md)

package/docs/reference/index.md

@@ -19,6 +19,7 @@
 - [ValidationError](classes/ValidationError.md)
 - [Factory](classes/Factory.md)
 - [ArrayHelper](classes/ArrayHelper.md)
+- [EnvHelper](classes/EnvHelper.md)
 - [ErrorHelper](classes/ErrorHelper.md)
 - [FilenameHelper](classes/FilenameHelper.md)
 - [HexHelper](classes/HexHelper.md)
@@ -26,6 +27,7 @@
 - [ObjectHelper](classes/ObjectHelper.md)
 - [RandomHelper](classes/RandomHelper.md)
 - [StringHelper](classes/StringHelper.md)
+- [Uint8ArrayHelper](classes/Uint8ArrayHelper.md)
 - [BitString](classes/BitString.md)
 - [Url](classes/Url.md)
 - [Urn](classes/Urn.md)
@@ -36,12 +38,14 @@
 - [Guards](classes/Guards.md)
 - [I18n](classes/I18n.md)
 - [Is](classes/Is.md)
+- [SharedStore](classes/SharedStore.md)
 - [Validation](classes/Validation.md)
 
 ## Interfaces
 
 - [IComponent](interfaces/IComponent.md)
 - [IError](interfaces/IError.md)
+- [II18nShared](interfaces/II18nShared.md)
 - [IKeyValue](interfaces/IKeyValue.md)
 - [ILabelledValue](interfaces/ILabelledValue.md)
 - [ILocale](interfaces/ILocale.md)
@@ -53,9 +57,12 @@
 
 ## Type Aliases
 
+- [CoerceType](type-aliases/CoerceType.md)
 - [CompressionType](type-aliases/CompressionType.md)
+- [ObjectOrArray](type-aliases/ObjectOrArray.md)
 
 ## Variables
 
 - [ComponentFactory](variables/ComponentFactory.md)
+- [CoerceType](variables/CoerceType.md)
 - [CompressionType](variables/CompressionType.md)

package/docs/reference/interfaces/IComponent.md

@@ -14,16 +14,22 @@ The name of the component.
 
 ### bootstrap()?
 
-> `optional` **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`boolean`\>
+> `optional` **bootstrap**(`nodeLoggingConnectorType`, `componentState?`): `Promise`\<`boolean`\>
 
 Bootstrap the component by creating and initializing any resources it needs.
 
 #### Parameters
 
-• **nodeLoggingConnectorType?**: `string`
+##### nodeLoggingConnectorType
 
 The node logging connector type, defaults to "node-logging".
 
+`undefined` | `string`
+
+##### componentState?
+
+A persistent state which can be modified by the method.
+
 #### Returns
 
 `Promise`\<`boolean`\>
@@ -34,20 +40,28 @@ True if the bootstrapping process was successful.
 
 ### start()?
 
-> `optional` **start**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\>
+> `optional` **start**(`nodeIdentity`, `nodeLoggingConnectorType`, `componentState?`): `Promise`\<`void`\>
 
 The component needs to be started when the node is initialized.
 
 #### Parameters
 
-• **nodeIdentity**: `string`
+##### nodeIdentity
+
+`string`
 
 The identity of the node starting the component.
 
-• **nodeLoggingConnectorType?**: `string`
+##### nodeLoggingConnectorType
 
 The node logging connector type, defaults to "node-logging".
 
+`undefined` | `string`
+
+##### componentState?
+
+A persistent state which can be modified by the method.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -58,20 +72,28 @@ Nothing.
 
 ### stop()?
 
-> `optional` **stop**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\>
+> `optional` **stop**(`nodeIdentity`, `nodeLoggingConnectorType`, `componentState?`): `Promise`\<`void`\>
 
 The component needs to be stopped when the node is closed.
 
 #### Parameters
 
-• **nodeIdentity**: `string`
+##### nodeIdentity
+
+`string`
 
 The identity of the node stopping the component.
 
-• **nodeLoggingConnectorType?**: `string`
+##### nodeLoggingConnectorType
 
 The node logging connector type, defaults to "node-logging".
 
+`undefined` | `string`
+
+##### componentState?
+
+A persistent state which can be modified by the method.
+
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/interfaces/IError.md

@@ -36,7 +36,7 @@ Any additional information for the error.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 ***
 
@@ -50,6 +50,6 @@ The stack trace for the error.
 
 ### inner?
 
-> `optional` **inner**: [`IError`](IError.md)
+> `optional` **inner**: `IError`
 
 The inner error if there was one.

package/docs/reference/interfaces/II18nShared.md

@@ -0,0 +1,47 @@
+# Interface: II18nShared
+
+The shared state for the I18n global.
+
+## Properties
+
+### localeDictionaries
+
+> **localeDictionaries**: `object`
+
+Dictionaries for lookups.
+
+#### Index Signature
+
+\[`locale`: `string`\]: `object`
+
+***
+
+### currentLocale
+
+> **currentLocale**: `string`
+
+The current locale.
+
+***
+
+### localeChangedHandlers
+
+> **localeChangedHandlers**: `object`
+
+Change handler for the locale being updated.
+
+#### Index Signature
+
+\[`id`: `string`\]: (`locale`) => `void`
+
+***
+
+### dictionaryChangedHandlers
+
+> **dictionaryChangedHandlers**: `object`
+
+Change handler for the dictionaries being updated.
+
+#### Index Signature
+
+\[`id`: `string`\]: (`locale`) => `void`

package/docs/reference/interfaces/IKeyValue.md

@@ -4,7 +4,9 @@ Interface describing a key/value pair.
 
 ## Type Parameters
 
-• **T**
+### T
+
+`T`
 
 ## Properties
 

package/docs/reference/interfaces/ILabelledValue.md

@@ -4,7 +4,9 @@ Interface describing a label/value pair.
 
 ## Type Parameters
 
-• **T**
+### T
+
+`T`
 
 ## Properties
 

package/docs/reference/interfaces/ILocaleDictionary.md

@@ -4,4 +4,4 @@ Type for the JSON locale dictionary files.
 
 ## Indexable
 
- \[`key`: `string`\]: `string` \| [`ILocaleDictionary`](ILocaleDictionary.md)
+\[`key`: `string`\]: `string` \| `ILocaleDictionary`

package/docs/reference/interfaces/IPatchOperation.md

@@ -6,7 +6,7 @@ Interface describing a patch operation to add a property.
 
 ### op
 
-> **op**: `"replace"` \| `"add"` \| `"remove"` \| `"copy"` \| `"move"` \| `"test"`
+> **op**: `"add"` \| `"remove"` \| `"replace"` \| `"move"` \| `"copy"` \| `"test"`
 
 The operation that was performed on the item.
 

package/docs/reference/interfaces/IValidationFailure.md

@@ -36,4 +36,4 @@ Additional properties for the validation failure.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`

package/docs/reference/type-aliases/CoerceType.md

@@ -0,0 +1,5 @@
+# Type Alias: CoerceType
+
+> **CoerceType** = *typeof* [`CoerceType`](../variables/CoerceType.md)\[keyof *typeof* [`CoerceType`](../variables/CoerceType.md)\]
+
+The types the extracted data can be coerced to.

package/docs/reference/type-aliases/CompressionType.md

@@ -1,5 +1,5 @@
 # Type Alias: CompressionType
 
-> **CompressionType**: *typeof* [`CompressionType`](../variables/CompressionType.md)\[keyof *typeof* [`CompressionType`](../variables/CompressionType.md)\]
+> **CompressionType** = *typeof* [`CompressionType`](../variables/CompressionType.md)\[keyof *typeof* [`CompressionType`](../variables/CompressionType.md)\]
 
 Compression types.

package/docs/reference/type-aliases/ObjectOrArray.md

@@ -0,0 +1,11 @@
+# Type Alias: ObjectOrArray\<T\>
+
+> **ObjectOrArray**\<`T`\> = `T` \| `T`[]
+
+Object or array data type
+
+## Type Parameters
+
+### T
+
+`T` = `unknown`

package/docs/reference/variables/CoerceType.md

@@ -0,0 +1,67 @@
+# Variable: CoerceType
+
+> `const` **CoerceType**: `object`
+
+The types the extracted data can be coerced to.
+
+## Type declaration
+
+### String
+
+> `readonly` **String**: `"string"` = `"string"`
+
+String.
+
+### Number
+
+> `readonly` **Number**: `"number"` = `"number"`
+
+Number.
+
+### Integer
+
+> `readonly` **Integer**: `"integer"` = `"integer"`
+
+Integer.
+
+### Boolean
+
+> `readonly` **Boolean**: `"boolean"` = `"boolean"`
+
+Boolean.
+
+### BigInt
+
+> `readonly` **BigInt**: `"bigint"` = `"bigint"`
+
+Big Integer.
+
+### Date
+
+> `readonly` **Date**: `"date"` = `"date"`
+
+Date.
+
+### DateTime
+
+> `readonly` **DateTime**: `"datetime"` = `"datetime"`
+
+Date Time.
+
+### Time
+
+> `readonly` **Time**: `"time"` = `"time"`
+
+Time.
+
+### Object
+
+> `readonly` **Object**: `"object"` = `"object"`
+
+Object.
+
+### Uint8Array
+
+> `readonly` **Uint8Array**: `"uint8array"` = `"uint8array"`
+
+Uint8Array.

package/docs/reference/variables/CompressionType.md

@@ -16,4 +16,4 @@ Gzip.
 
 > `readonly` **Deflate**: `"deflate"` = `"deflate"`
 
-deflate.
+Deflate.

package/locales/en.json

@@ -8,6 +8,10 @@
 			"beTextMinMax": "{fieldName} must be longer than {minLength} and shorter than {maxLength} characters",
 			"beTextMin": "{fieldName} must be longer than {minLength} characters",
 			"beTextMax": "{fieldName} must be shorter than {maxLength} characters",
+			"beTextBase58": "{fieldName} must be text formatted using Base58 characters",
+			"beTextBase64": "{fieldName} must be text formatted using Base64 characters",
+			"beTextHex": "{fieldName} must be text formatted using Hex characters",
+			"beTextRegExp": "{fieldName} must be text formatted using the matching pattern {format}",
 			"beNumber": "{fieldName} must be a number",
 			"beNumberMinMax": "{fieldName} must be >= {minValue} and <= {maxValue}",
 			"beNumberMin": "{fieldName} must be >= {minValue}",
@@ -44,8 +48,10 @@
 			"stringEmpty": "Property \"{property}\" must have a value, it is empty",
 			"stringBase64": "Property \"{property}\" must be a base64 encoded string, it is \"{value}\"",
 			"stringBase64Url": "Property \"{property}\" must be a base64 url encoded string, it is \"{value}\"",
+			"stringBase58": "Property \"{property}\" must be a base58 encoded string, it is \"{value}\"",
 			"stringHex": "Property \"{property}\" must be a hex string, it is \"{value}\"",
 			"stringHexLength": "Property \"{property}\" must be a hex string of length \"{options}\", it is \"{value}\"",
+			"stringJson": "Property \"{property}\" must be a JSON string",
 			"number": "Property \"{property}\" must be a number, it is \"{value}\"",
 			"integer": "Property \"{property}\" must be an integer, it is \"{value}\"",
 			"bigint": "Property \"{property}\" must be a bigint, it is \"{value}\"",
@@ -59,6 +65,8 @@
 			"array": "Property \"{property}\" must be an array, it is \"{value}\"",
 			"arrayValue": "Property \"{property}\" must be an array with at least one item",
 			"arrayOneOf": "Property \"{property}\" must be one of [{options}], it is \"{value}\"",
+			"arrayStartsWith": "Property \"{property}\" must be an array starting with [{startValues}], it is \"{value}\"",
+			"arrayEndsWith": "Property \"{property}\" must be an array ending with [{endValues}], it is \"{value}\"",
 			"uint8Array": "Property \"{property}\" must be a Uint8Array, it is \"{value}\"",
 			"function": "Property \"{property}\" must be a function, it is \"{value}\"",
 			"urn": "Property \"{property}\" must be a Urn formatted string, it is \"{value}\"",
@@ -66,7 +74,9 @@
 			"email": "Property \"{property}\" must be string in e-mail format, it is \"{value}\""
 		},
 		"objectHelper": {
-			"failedBytesToJSON": "Failed converting bytes to JSON"
+			"failedBytesToJSON": "Failed converting bytes to JSON",
+			"cannotSetArrayIndex": "Cannot set property \"{property}\" using index \"{index}\" as it is not an array",
+			"cannotSetProperty": "Cannot set property \"{property}\" when the target is not an object"
 		},
 		"common": {
 			"notImplementedMethod": "The method \"{method}\" has not been implemented",
@@ -87,6 +97,9 @@
 		},
 		"base58": {
 			"invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
+		},
+		"jsonHelper": {
+			"failedPatch": "Failed to patch the JSON object, patch index \"{index}\" failed"
 		}
 	},
 	"errorNames": {