@twin.org/core 0.0.1-next.51 → 0.0.1-next.53

package/docs/reference/classes/UnprocessableError.md

@@ -8,9 +8,9 @@ Class to handle errors when some data can not be processed.
 
 ## Constructors
 
-### new UnprocessableError()
+### Constructor
 
-> **new UnprocessableError**(`source`, `message`, `properties`?, `inner`?): [`UnprocessableError`](UnprocessableError.md)
+> **new UnprocessableError**(`source`, `message`, `properties?`, `inner?`): `UnprocessableError`
 
 Create a new instance of UnprocessableError.
 
@@ -40,11 +40,11 @@ The inner error if we have wrapped another error.
 
 #### Returns
 
-[`UnprocessableError`](UnprocessableError.md)
+`UnprocessableError`
 
 #### Overrides
 
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructor)
 
 ## Properties
 
@@ -56,7 +56,7 @@ The source of the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`source`](BaseError.md#source-1)
+[`BaseError`](BaseError.md).[`source`](BaseError.md#source)
 
 ***
 
@@ -72,7 +72,7 @@ Any additional information for the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties-1)
+[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties)
 
 ***
 
@@ -84,7 +84,7 @@ The inner error if there was one.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner-1)
+[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
 
 ***
 

package/docs/reference/classes/Url.md

@@ -4,9 +4,9 @@ Class to help with urls.
 
 ## Constructors
 
-### new Url()
+### Constructor
 
-> **new Url**(`url`): [`Url`](Url.md)
+> **new Url**(`url`): `Url`
 
 Create a new instance of Url.
 
@@ -20,13 +20,13 @@ The url string.
 
 #### Returns
 
-[`Url`](Url.md)
+`Url`
 
 ## Methods
 
 ### tryParseExact()
 
-> `static` **tryParseExact**(`url`): `undefined` \| [`Url`](Url.md)
+> `static` **tryParseExact**(`url`): `undefined` \| `Url`
 
 Try and parse a string into the url parts.
 
@@ -40,7 +40,7 @@ The url to parse.
 
 #### Returns
 
-`undefined` \| [`Url`](Url.md)
+`undefined` \| `Url`
 
 The formatted url or undefined if the value is not a url.
 
@@ -140,7 +140,7 @@ The formatted url.
 
 ### fromParts()
 
-> `static` **fromParts**(`urlParts`): [`Url`](Url.md)
+> `static` **fromParts**(`urlParts`): `Url`
 
 Construct a url from valid parts.
 
@@ -154,7 +154,7 @@ The url to create the parts from.
 
 #### Returns
 
-[`Url`](Url.md)
+`Url`
 
 The formatted url.
 

package/docs/reference/classes/Urn.md

@@ -4,9 +4,9 @@ Class to help with urns.
 
 ## Constructors
 
-### new Urn()
+### Constructor
 
-> **new Urn**(`namespaceIdentifier`, `namespaceSpecific`): [`Urn`](Urn.md)
+> **new Urn**(`namespaceIdentifier`, `namespaceSpecific`): `Urn`
 
 Create a new instance of Urn.
 
@@ -26,13 +26,13 @@ The specific part of the namespace.
 
 #### Returns
 
-[`Urn`](Urn.md)
+`Urn`
 
 ## Methods
 
 ### generateRandom()
 
-> `static` **generateRandom**(`namespace`): [`Urn`](Urn.md)
+> `static` **generateRandom**(`namespace`): `Urn`
 
 Generate a random identifier with 32 byte id.
 
@@ -46,7 +46,7 @@ The prefix for the urn.
 
 #### Returns
 
-[`Urn`](Urn.md)
+`Urn`
 
 A new Id in URN format.
 
@@ -82,7 +82,7 @@ True if the namespace matches.
 
 ### tryParseExact()
 
-> `static` **tryParseExact**(`urn`): `undefined` \| [`Urn`](Urn.md)
+> `static` **tryParseExact**(`urn`): `undefined` \| `Urn`
 
 Try and parse a string into the urn parts.
 
@@ -96,7 +96,7 @@ The urn to parse.
 
 #### Returns
 
-`undefined` \| [`Urn`](Urn.md)
+`undefined` \| `Urn`
 
 The formatted urn or undefined if the value is not a urn.
 
@@ -104,7 +104,7 @@ The formatted urn or undefined if the value is not a urn.
 
 ### fromValidString()
 
-> `static` **fromValidString**(`urn`): [`Urn`](Urn.md)
+> `static` **fromValidString**(`urn`): `Urn`
 
 Construct a urn from a string that has already been validated.
 
@@ -118,7 +118,7 @@ The urn to parse.
 
 #### Returns
 
-[`Urn`](Urn.md)
+`Urn`
 
 The formatted urn.
 

package/docs/reference/classes/Validation.md

@@ -4,19 +4,19 @@ Class to handle validation operations.
 
 ## Constructors
 
-### new Validation()
+### Constructor
 
-> **new Validation**(): [`Validation`](Validation.md)
+> **new Validation**(): `Validation`
 
 #### Returns
 
-[`Validation`](Validation.md)
+`Validation`
 
 ## Methods
 
 ### empty()
 
-> `static` **empty**(`property`, `value`, `failures`, `fieldNameResource`?): value is undefined \| null
+> `static` **empty**(`property`, `value`, `failures`, `fieldNameResource?`): value is undefined \| null
 
 Is the property null or undefined.
 
@@ -56,7 +56,7 @@ True if the value is a empty.
 
 ### notEmpty()
 
-> `static` **notEmpty**(`property`, `value`, `failures`, `fieldNameResource`?): `boolean`
+> `static` **notEmpty**(`property`, `value`, `failures`, `fieldNameResource?`): `boolean`
 
 Is the property is not null or undefined.
 
@@ -96,7 +96,7 @@ True if the value is a not empty.
 
 ### string()
 
-> `static` **string**(`property`, `value`, `failures`, `fieldNameResource`?, `options`?): `value is string`
+> `static` **string**(`property`, `value`, `failures`, `fieldNameResource?`, `options?`): `value is string`
 
 Is the property a string.
 
@@ -158,7 +158,7 @@ True if the value is a valid string.
 
 ### stringValue()
 
-> `static` **stringValue**(`property`, `value`, `failures`, `fieldNameResource`?, `options`?): `value is string`
+> `static` **stringValue**(`property`, `value`, `failures`, `fieldNameResource?`, `options?`): `value is string`
 
 Is the property a string with a value.
 
@@ -214,7 +214,7 @@ True if the value is a valid string.
 
 ### number()
 
-> `static` **number**(`property`, `value`, `failures`, `fieldNameResource`?, `options`?): `value is number`
+> `static` **number**(`property`, `value`, `failures`, `fieldNameResource?`, `options?`): `value is number`
 
 Is the property a number.
 
@@ -270,7 +270,7 @@ True if the value is a valid number.
 
 ### integer()
 
-> `static` **integer**(`property`, `value`, `failures`, `fieldNameResource`?, `options`?): `value is number`
+> `static` **integer**(`property`, `value`, `failures`, `fieldNameResource?`, `options?`): `value is number`
 
 Is the property an integer.
 
@@ -326,7 +326,7 @@ True if the value is a valid integer.
 
 ### bigint()
 
-> `static` **bigint**(`property`, `value`, `failures`, `fieldNameResource`?, `options`?): `value is bigint`
+> `static` **bigint**(`property`, `value`, `failures`, `fieldNameResource?`, `options?`): `value is bigint`
 
 Is the property a bigint.
 
@@ -382,7 +382,7 @@ True if the value is a valid bigint.
 
 ### boolean()
 
-> `static` **boolean**(`property`, `value`, `failures`, `fieldNameResource`?): `value is boolean`
+> `static` **boolean**(`property`, `value`, `failures`, `fieldNameResource?`): `value is boolean`
 
 Is the property a boolean.
 
@@ -422,7 +422,7 @@ True if the value is a boolean.
 
 ### date()
 
-> `static` **date**(`property`, `value`, `failures`, `fieldNameResource`?): `value is Date`
+> `static` **date**(`property`, `value`, `failures`, `fieldNameResource?`): `value is Date`
 
 Is the property a date.
 
@@ -462,7 +462,7 @@ True if the value is a date.
 
 ### dateString()
 
-> `static` **dateString**(`property`, `value`, `failures`, `fieldNameResource`?): `value is string`
+> `static` **dateString**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
 Is the property a date in ISO 8601 format.
 
@@ -502,7 +502,7 @@ True if the value is a date.
 
 ### dateTimeString()
 
-> `static` **dateTimeString**(`property`, `value`, `failures`, `fieldNameResource`?): `value is string`
+> `static` **dateTimeString**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
 Is the property a date/time in ISO 8601 format.
 
@@ -542,7 +542,7 @@ True if the value is a date/time.
 
 ### timeString()
 
-> `static` **timeString**(`property`, `value`, `failures`, `fieldNameResource`?): `value is string`
+> `static` **timeString**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
 Is the property a time in ISO 8601 format.
 
@@ -582,7 +582,7 @@ True if the value is a time.
 
 ### timestampMilliseconds()
 
-> `static` **timestampMilliseconds**(`property`, `value`, `failures`, `fieldNameResource`?): `value is number`
+> `static` **timestampMilliseconds**(`property`, `value`, `failures`, `fieldNameResource?`): `value is number`
 
 Is the property a timestamp in milliseconds.
 
@@ -622,7 +622,7 @@ True if the value is a timestamp in milliseconds.
 
 ### timestampSeconds()
 
-> `static` **timestampSeconds**(`property`, `value`, `failures`, `fieldNameResource`?): `value is number`
+> `static` **timestampSeconds**(`property`, `value`, `failures`, `fieldNameResource?`): `value is number`
 
 Is the property a timestamp in seconds.
 
@@ -662,13 +662,15 @@ True if the value is a timestamp in seconds.
 
 ### object()
 
-> `static` **object**\<`T`\>(`property`, `value`, `failures`, `fieldNameResource`?): `value is T`
+> `static` **object**\<`T`\>(`property`, `value`, `failures`, `fieldNameResource?`): `value is T`
 
 Is the property an object.
 
 #### Type Parameters
 
-• **T** = \{\}
+##### T
+
+`T` = \{[`id`: `string`]: `unknown`; \}
 
 #### Parameters
 
@@ -706,13 +708,15 @@ True if the value is a object.
 
 ### array()
 
-> `static` **array**\<`T`\>(`property`, `value`, `failures`, `fieldNameResource`?): `value is T[]`
+> `static` **array**\<`T`\>(`property`, `value`, `failures`, `fieldNameResource?`): `value is T[]`
 
 Is the property an array.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
@@ -750,13 +754,15 @@ True if the value is an array.
 
 ### arrayValue()
 
-> `static` **arrayValue**\<`T`\>(`property`, `value`, `failures`, `fieldNameResource`?): `value is T[]`
+> `static` **arrayValue**\<`T`\>(`property`, `value`, `failures`, `fieldNameResource?`): `value is T[]`
 
 Is the property an array with at least one item.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
@@ -794,13 +800,15 @@ True if the value is an array with at least one element.
 
 ### arrayOneOf()
 
-> `static` **arrayOneOf**\<`T`\>(`property`, `value`, `options`, `failures`, `fieldNameResource`?): `value is T`
+> `static` **arrayOneOf**\<`T`\>(`property`, `value`, `options`, `failures`, `fieldNameResource?`): `value is T`
 
 Is the property one of a list of items.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
@@ -844,7 +852,7 @@ True if the value is one of the items in the options.
 
 ### uint8Array()
 
-> `static` **uint8Array**(`property`, `value`, `failures`, `fieldNameResource`?): `value is Uint8Array<ArrayBufferLike>`
+> `static` **uint8Array**(`property`, `value`, `failures`, `fieldNameResource?`): `value is Uint8Array<ArrayBufferLike>`
 
 Is the property a Uint8Array.
 
@@ -884,7 +892,7 @@ True if the value is a Uint8Array.
 
 ### json()
 
-> `static` **json**(`property`, `value`, `failures`, `fieldNameResource`?): `value is string`
+> `static` **json**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
 Is the property valid JSON.
 
@@ -924,7 +932,7 @@ True if the value is valid JSON.
 
 ### email()
 
-> `static` **email**(`property`, `value`, `failures`, `fieldNameResource`?): `value is string`
+> `static` **email**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
 Is the property a string in e-mail format.
 

package/docs/reference/classes/ValidationError.md

@@ -8,9 +8,9 @@ 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.
 
@@ -36,11 +36,11 @@ The validation failures.
 
 #### Returns
 
-[`ValidationError`](ValidationError.md)
+`ValidationError`
 
 #### Overrides
 
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructor)
 
 ## Properties
 
@@ -52,7 +52,7 @@ The source of the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`source`](BaseError.md#source-1)
+[`BaseError`](BaseError.md).[`source`](BaseError.md#source)
 
 ***
 
@@ -68,7 +68,7 @@ Any additional information for the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties-1)
+[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties)
 
 ***
 
@@ -80,7 +80,7 @@ The inner error if there was one.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner-1)
+[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
 
 ***
 

package/docs/reference/index.md

@@ -38,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)

package/docs/reference/interfaces/IComponent.md

@@ -14,7 +14,7 @@ The name of the component.
 
 ### bootstrap()?
 
-> `optional` **bootstrap**(`nodeLoggingConnectorType`, `componentState`?): `Promise`\<`boolean`\>
+> `optional` **bootstrap**(`nodeLoggingConnectorType`, `componentState?`): `Promise`\<`boolean`\>
 
 Bootstrap the component by creating and initializing any resources it needs.
 
@@ -40,7 +40,7 @@ True if the bootstrapping process was successful.
 
 ### start()?
 
-> `optional` **start**(`nodeIdentity`, `nodeLoggingConnectorType`, `componentState`?): `Promise`\<`void`\>
+> `optional` **start**(`nodeIdentity`, `nodeLoggingConnectorType`, `componentState?`): `Promise`\<`void`\>
 
 The component needs to be started when the node is initialized.
 
@@ -72,7 +72,7 @@ Nothing.
 
 ### stop()?
 
-> `optional` **stop**(`nodeIdentity`, `nodeLoggingConnectorType`, `componentState`?): `Promise`\<`void`\>
+> `optional` **stop**(`nodeIdentity`, `nodeLoggingConnectorType`, `componentState?`): `Promise`\<`void`\>
 
 The component needs to be stopped when the node is closed.
 

package/docs/reference/interfaces/IError.md

@@ -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/type-aliases/CoerceType.md

@@ -1,5 +1,5 @@
 # Type Alias: CoerceType
 
-> **CoerceType**: *typeof* [`CoerceType`](../variables/CoerceType.md)\[keyof *typeof* [`CoerceType`](../variables/CoerceType.md)\]
+> **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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.1-next.51",
+	"version": "0.0.1-next.53",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",
@@ -15,7 +15,7 @@
 	},
 	"dependencies": {
 		"@twin.org/nameof": "next",
-		"intl-messageformat": "10.7.15",
+		"intl-messageformat": "10.7.16",
 		"rfc6902": "5.1.2"
 	},
 	"main": "./dist/cjs/index.cjs",