@twin.org/core 0.0.1-next.1

package/docs/reference/classes/ValidationError.md

@@ -0,0 +1,371 @@
+# Class: ValidationError
+
+Class to handle errors which are triggered by entity validation.
+
+## Extends
+
+- [`BaseError`](BaseError.md)
+
+## Constructors
+
+### new ValidationError()
+
+> **new ValidationError**(`source`, `validationObject`, `validationFailures`): [`ValidationError`](ValidationError.md)
+
+Create a new instance of ValidationError.
+
+#### Parameters
+
+• **source**: `string`
+
+The source of the error.
+
+• **validationObject**: `string`
+
+The object that failed validation.
+
+• **validationFailures**: [`IValidationFailure`](../interfaces/IValidationFailure.md)[]
+
+The validation failures.
+
+#### Returns
+
+[`ValidationError`](ValidationError.md)
+
+#### Overrides
+
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+
+## Properties
+
+### 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)
+
+***
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.s
+
+## 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/index.md

@@ -0,0 +1,60 @@
+# @twin.org/core
+
+## Classes
+
+- [Base32](classes/Base32.md)
+- [Base64](classes/Base64.md)
+- [Base64Url](classes/Base64Url.md)
+- [AlreadyExistsError](classes/AlreadyExistsError.md)
+- [BaseError](classes/BaseError.md)
+- [ConflictError](classes/ConflictError.md)
+- [GeneralError](classes/GeneralError.md)
+- [GuardError](classes/GuardError.md)
+- [NotFoundError](classes/NotFoundError.md)
+- [NotImplementedError](classes/NotImplementedError.md)
+- [NotSupportedError](classes/NotSupportedError.md)
+- [UnauthorizedError](classes/UnauthorizedError.md)
+- [UnprocessableError](classes/UnprocessableError.md)
+- [ValidationError](classes/ValidationError.md)
+- [Factory](classes/Factory.md)
+- [ArrayHelper](classes/ArrayHelper.md)
+- [ErrorHelper](classes/ErrorHelper.md)
+- [FilenameHelper](classes/FilenameHelper.md)
+- [HexHelper](classes/HexHelper.md)
+- [JsonHelper](classes/JsonHelper.md)
+- [ObjectHelper](classes/ObjectHelper.md)
+- [RandomHelper](classes/RandomHelper.md)
+- [StringHelper](classes/StringHelper.md)
+- [BitString](classes/BitString.md)
+- [Url](classes/Url.md)
+- [Urn](classes/Urn.md)
+- [AsyncCache](classes/AsyncCache.md)
+- [Coerce](classes/Coerce.md)
+- [Compression](classes/Compression.md)
+- [Converter](classes/Converter.md)
+- [Guards](classes/Guards.md)
+- [I18n](classes/I18n.md)
+- [Is](classes/Is.md)
+- [Validation](classes/Validation.md)
+
+## Interfaces
+
+- [IComponent](interfaces/IComponent.md)
+- [IError](interfaces/IError.md)
+- [IKeyValue](interfaces/IKeyValue.md)
+- [ILabelledValue](interfaces/ILabelledValue.md)
+- [ILocale](interfaces/ILocale.md)
+- [ILocaleDictionary](interfaces/ILocaleDictionary.md)
+- [ILocalesIndex](interfaces/ILocalesIndex.md)
+- [IPatchOperation](interfaces/IPatchOperation.md)
+- [IUrlParts](interfaces/IUrlParts.md)
+- [IValidationFailure](interfaces/IValidationFailure.md)
+
+## Type Aliases
+
+- [CompressionType](type-aliases/CompressionType.md)
+
+## Variables
+
+- [ComponentFactory](variables/ComponentFactory.md)
+- [CompressionType](variables/CompressionType.md)

package/docs/reference/interfaces/IComponent.md

@@ -0,0 +1,79 @@
+# Interface: IComponent
+
+Interface describing a component which can be bootstrapped, started and stopped.
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+The name of the component.
+
+## Methods
+
+### bootstrap()?
+
+> `optional` **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`boolean`\>
+
+Bootstrap the component by creating and initializing any resources it needs.
+
+#### Parameters
+
+• **nodeLoggingConnectorType?**: `string`
+
+The node logging connector type, defaults to "node-logging".
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the bootstrapping process was successful.
+
+***
+
+### start()?
+
+> `optional` **start**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\>
+
+The component needs to be started when the node is initialized.
+
+#### Parameters
+
+• **nodeIdentity**: `string`
+
+The identity of the node starting the component.
+
+• **nodeLoggingConnectorType?**: `string`
+
+The node logging connector type, defaults to "node-logging".
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### stop()?
+
+> `optional` **stop**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\>
+
+The component needs to be stopped when the node is closed.
+
+#### Parameters
+
+• **nodeIdentity**: `string`
+
+The identity of the node stopping the component.
+
+• **nodeLoggingConnectorType?**: `string`
+
+The node logging connector type, defaults to "node-logging".
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

package/docs/reference/interfaces/IError.md

@@ -0,0 +1,55 @@
+# Interface: IError
+
+Model to describe serialized error.
+
+## Properties
+
+### name
+
+> **name**: `string`
+
+The name for the error.
+
+***
+
+### message
+
+> **message**: `string`
+
+The message for the error.
+
+***
+
+### source?
+
+> `optional` **source**: `string`
+
+The source of the error.
+
+***
+
+### properties?
+
+> `optional` **properties**: `object`
+
+Any additional information for the error.
+
+#### Index Signature
+
+ \[`id`: `string`\]: `unknown`
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+The stack trace for the error.
+
+***
+
+### inner?
+
+> `optional` **inner**: [`IError`](IError.md)
+
+The inner error if there was one.

package/docs/reference/interfaces/IKeyValue.md

@@ -0,0 +1,23 @@
+# Interface: IKeyValue\<T\>
+
+Interface describing a key/value pair.
+
+## Type Parameters
+
+• **T**
+
+## Properties
+
+### key
+
+> **key**: `string`
+
+The key for the item.
+
+***
+
+### value
+
+> **value**: `T`
+
+The value for the item.

package/docs/reference/interfaces/ILabelledValue.md

@@ -0,0 +1,23 @@
+# Interface: ILabelledValue\<T\>
+
+Interface describing a label/value pair.
+
+## Type Parameters
+
+• **T**
+
+## Properties
+
+### label
+
+> **label**: `string`
+
+The label for the item.
+
+***
+
+### value
+
+> **value**: `T`
+
+The value for the item.

package/docs/reference/interfaces/ILocale.md

@@ -0,0 +1,19 @@
+# Interface: ILocale
+
+Model for a local.
+
+## Properties
+
+### label
+
+> **label**: `string`
+
+The label.
+
+***
+
+### code
+
+> **code**: `string`
+
+The code.

package/docs/reference/interfaces/ILocaleDictionary.md

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

package/docs/reference/interfaces/ILocalesIndex.md

@@ -0,0 +1,11 @@
+# Interface: ILocalesIndex
+
+Model for a locales index.
+
+## Properties
+
+### locales
+
+> **locales**: [`ILocale`](ILocale.md)[]
+
+The list of locales.

package/docs/reference/interfaces/IPatchOperation.md

@@ -0,0 +1,35 @@
+# Interface: IPatchOperation
+
+Interface describing a patch operation to add a property.
+
+## Properties
+
+### op
+
+> **op**: `"replace"` \| `"add"` \| `"remove"` \| `"copy"` \| `"move"` \| `"test"`
+
+The operation that was performed on the item.
+
+***
+
+### path
+
+> **path**: `string`
+
+The path to the object that was changed.
+
+***
+
+### from?
+
+> `optional` **from**: `string`
+
+The path the value was copied or moved from.
+
+***
+
+### value?
+
+> `optional` **value**: `unknown`
+
+The value to add.