@twin.org/core 0.0.1-next.1

package/docs/reference/classes/ConflictError.md

@@ -0,0 +1,379 @@
+# Class: ConflictError
+
+Class to handle errors which are triggered by conflicting data.
+
+## Extends
+
+- [`BaseError`](BaseError.md)
+
+## Constructors
+
+### new ConflictError()
+
+> **new ConflictError**(`source`, `message`, `conflictId`?, `conflicts`?, `inner`?): [`ConflictError`](ConflictError.md)
+
+Create a new instance of ConflictError.
+
+#### Parameters
+
+• **source**: `string`
+
+The source of the error.
+
+• **message**: `string`
+
+The message as a code.
+
+• **conflictId?**: `string`
+
+The id that has conflicts.
+
+• **conflicts?**: `string`[]
+
+The conflicts that occurred.
+
+• **inner?**: `unknown`
+
+The inner error if we have wrapped another error.
+
+#### Returns
+
+[`ConflictError`](ConflictError.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.
+
+## 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/Converter.md

@@ -0,0 +1,285 @@
+# Class: Converter
+
+Convert arrays to and from different formats.
+
+## Constructors
+
+### new Converter()
+
+> **new Converter**(): [`Converter`](Converter.md)
+
+#### Returns
+
+[`Converter`](Converter.md)
+
+## Methods
+
+### bytesToUtf8()
+
+> `static` **bytesToUtf8**(`array`, `startIndex`?, `length`?): `string`
+
+Encode a raw array to UTF8 string.
+
+#### Parameters
+
+• **array**: `ArrayLike`\<`number`\>
+
+The bytes to encode.
+
+• **startIndex?**: `number`
+
+The index to start in the bytes.
+
+• **length?**: `number`
+
+The length of bytes to read.
+
+#### Returns
+
+`string`
+
+The array formatted as UTF8.
+
+***
+
+### utf8ToBytes()
+
+> `static` **utf8ToBytes**(`utf8`): `Uint8Array`
+
+Convert a UTF8 string to raw array.
+
+#### Parameters
+
+• **utf8**: `string`
+
+The text to decode.
+
+#### Returns
+
+`Uint8Array`
+
+The array.
+
+***
+
+### bytesToHex()
+
+> `static` **bytesToHex**(`array`, `includePrefix`, `startIndex`?, `length`?, `reverse`?): `string`
+
+Encode a raw array to hex string.
+
+#### Parameters
+
+• **array**: `ArrayLike`\<`number`\>
+
+The bytes to encode.
+
+• **includePrefix**: `boolean` = `false`
+
+Include the 0x prefix on the returned hex.
+
+• **startIndex?**: `number`
+
+The index to start in the bytes.
+
+• **length?**: `number`
+
+The length of bytes to read.
+
+• **reverse?**: `boolean`
+
+Reverse the combine direction.
+
+#### Returns
+
+`string`
+
+The array formatted as hex.
+
+***
+
+### hexToBytes()
+
+> `static` **hexToBytes**(`hex`, `reverse`?): `Uint8Array`
+
+Decode a hex string to raw array.
+
+#### Parameters
+
+• **hex**: `string`
+
+The hex to decode.
+
+• **reverse?**: `boolean`
+
+Store the characters in reverse.
+
+#### Returns
+
+`Uint8Array`
+
+The array.
+
+***
+
+### utf8ToHex()
+
+> `static` **utf8ToHex**(`utf8`, `includePrefix`): `string`
+
+Convert the UTF8 to hex.
+
+#### Parameters
+
+• **utf8**: `string`
+
+The text to convert.
+
+• **includePrefix**: `boolean` = `false`
+
+Include the 0x prefix on the returned hex.
+
+#### Returns
+
+`string`
+
+The hex version of the bytes.
+
+***
+
+### hexToUtf8()
+
+> `static` **hexToUtf8**(`hex`): `string`
+
+Convert the hex text to text.
+
+#### Parameters
+
+• **hex**: `string`
+
+The hex to convert.
+
+#### Returns
+
+`string`
+
+The UTF8 version of the bytes.
+
+***
+
+### bytesToBinary()
+
+> `static` **bytesToBinary**(`bytes`): `string`
+
+Convert bytes to binary string.
+
+#### Parameters
+
+• **bytes**: `Uint8Array`
+
+The bytes to convert.
+
+#### Returns
+
+`string`
+
+A binary string of the bytes.
+
+***
+
+### binaryToBytes()
+
+> `static` **binaryToBytes**(`binary`): `Uint8Array`
+
+Convert a binary string to bytes.
+
+#### Parameters
+
+• **binary**: `string`
+
+The binary string.
+
+#### Returns
+
+`Uint8Array`
+
+The bytes.
+
+***
+
+### bytesToBase64()
+
+> `static` **bytesToBase64**(`bytes`): `string`
+
+Convert bytes to base64 string.
+
+#### Parameters
+
+• **bytes**: `Uint8Array`
+
+The bytes to convert.
+
+#### Returns
+
+`string`
+
+A base64 string of the bytes.
+
+***
+
+### base64ToBytes()
+
+> `static` **base64ToBytes**(`base64`): `Uint8Array`
+
+Convert a base64 string to bytes.
+
+#### Parameters
+
+• **base64**: `string`
+
+The base64 string.
+
+#### Returns
+
+`Uint8Array`
+
+The bytes.
+
+***
+
+### bytesToBase64Url()
+
+> `static` **bytesToBase64Url**(`bytes`): `string`
+
+Convert bytes to base64 url string.
+
+#### Parameters
+
+• **bytes**: `Uint8Array`
+
+The bytes to convert.
+
+#### Returns
+
+`string`
+
+A base64 url string of the bytes.
+
+***
+
+### base64UrlToBytes()
+
+> `static` **base64UrlToBytes**(`base64Url`): `Uint8Array`
+
+Convert a base64 url string to bytes.
+
+#### Parameters
+
+• **base64Url**: `string`
+
+The base64 url string.
+
+#### Returns
+
+`Uint8Array`
+
+The bytes.

package/docs/reference/classes/ErrorHelper.md

@@ -0,0 +1,73 @@
+# Class: ErrorHelper
+
+Error helper functions.
+
+## Constructors
+
+### new ErrorHelper()
+
+> **new ErrorHelper**(): [`ErrorHelper`](ErrorHelper.md)
+
+#### Returns
+
+[`ErrorHelper`](ErrorHelper.md)
+
+## Methods
+
+### formatErrors()
+
+> `static` **formatErrors**(`error`): `string`[]
+
+Format Errors and returns just their messages.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to format.
+
+#### Returns
+
+`string`[]
+
+The error formatted including any inner errors.
+
+***
+
+### localizeErrors()
+
+> `static` **localizeErrors**(`error`): [`IError`](../interfaces/IError.md)[]
+
+Localize the content of an error and any inner errors.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to format.
+
+#### Returns
+
+[`IError`](../interfaces/IError.md)[]
+
+The localized version of the errors flattened.
+
+***
+
+### formatValidationErrors()
+
+> `static` **formatValidationErrors**(`error`): `undefined` \| `string`
+
+Localize the content of an error and any inner errors.
+
+#### Parameters
+
+• **error**: [`IError`](../interfaces/IError.md)
+
+The error to format.
+
+#### Returns
+
+`undefined` \| `string`
+
+The localized version of the errors flattened.