@twin.org/core 0.0.1-next.1

package/docs/reference/classes/AsyncCache.md

@@ -0,0 +1,117 @@
+# Class: AsyncCache
+
+Cache the results from asynchronous requests.
+
+## Constructors
+
+### new AsyncCache()
+
+> **new AsyncCache**(): [`AsyncCache`](AsyncCache.md)
+
+#### Returns
+
+[`AsyncCache`](AsyncCache.md)
+
+## Methods
+
+### exec()
+
+> `static` **exec**\<`T`\>(`key`, `ttlMs`, `requestMethod`): `undefined` \| `Promise`\<`T`\>
+
+Execute an async request and cache the result.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **key**: `string`
+
+The key for the entry in the cache.
+
+• **ttlMs**: `undefined` \| `number`
+
+The TTL of the entry in the cache.
+
+• **requestMethod**
+
+The method to call if not cached.
+
+#### Returns
+
+`undefined` \| `Promise`\<`T`\>
+
+The response.
+
+***
+
+### get()
+
+> `static` **get**\<`T`\>(`key`): `Promise`\<`undefined` \| `T`\>
+
+Get an entry from the cache.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **key**: `string`
+
+The key to get from the cache.
+
+#### Returns
+
+`Promise`\<`undefined` \| `T`\>
+
+The item from the cache if it exists.
+
+***
+
+### remove()
+
+> `static` **remove**(`key`): `void`
+
+Remove an entry from the cache.
+
+#### Parameters
+
+• **key**: `string`
+
+The key to remove from the cache.
+
+#### Returns
+
+`void`
+
+***
+
+### clearCache()
+
+> `static` **clearCache**(`prefix`?): `void`
+
+Clear the cache.
+
+#### Parameters
+
+• **prefix?**: `string`
+
+Optional prefix to clear only entries with that prefix.
+
+#### Returns
+
+`void`
+
+***
+
+### cleanupExpired()
+
+> `static` **cleanupExpired**(): `void`
+
+Perform a cleanup of the expired entries in the cache.
+
+#### Returns
+
+`void`

package/docs/reference/classes/Base32.md

@@ -0,0 +1,57 @@
+# Class: Base32
+
+Class to help with base63 Encoding/Decoding.
+
+## Constructors
+
+### new Base32()
+
+> **new Base32**(): [`Base32`](Base32.md)
+
+#### Returns
+
+[`Base32`](Base32.md)
+
+## Methods
+
+### decode()
+
+> `static` **decode**(`base32`): `Uint8Array`
+
+Convert the base 32 string to a byte array.
+
+#### Parameters
+
+• **base32**: `string`
+
+The base32 string to convert.
+
+#### Returns
+
+`Uint8Array`
+
+The byte array.
+
+#### Throws
+
+If the input string contains a character not in the Base32 alphabet.
+
+***
+
+### encode()
+
+> `static` **encode**(`bytes`): `string`
+
+Convert a byte array to base 32.
+
+#### Parameters
+
+• **bytes**: `Uint8Array`
+
+The byte array to convert.
+
+#### Returns
+
+`string`
+
+The data as base32 string.

package/docs/reference/classes/Base64.md

@@ -0,0 +1,74 @@
+# Class: Base64
+
+Class to help with base64 Encoding/Decoding.
+Sourced from https://github.com/beatgammit/base64-js.
+
+## Constructors
+
+### new Base64()
+
+> **new Base64**(): [`Base64`](Base64.md)
+
+#### Returns
+
+[`Base64`](Base64.md)
+
+## Methods
+
+### byteLength()
+
+> `static` **byteLength**(`base64`): `number`
+
+Get the byte length of the data.
+
+#### Parameters
+
+• **base64**: `string`
+
+The base64 string.
+
+#### Returns
+
+`number`
+
+The byte length of the data.
+
+***
+
+### decode()
+
+> `static` **decode**(`base64`): `Uint8Array`
+
+Convert the base 64 string to a byte array.
+
+#### Parameters
+
+• **base64**: `string`
+
+The base64 string to convert.
+
+#### Returns
+
+`Uint8Array`
+
+The byte array.
+
+***
+
+### encode()
+
+> `static` **encode**(`bytes`): `string`
+
+Convert a byte array to base 64.
+
+#### Parameters
+
+• **bytes**: `Uint8Array`
+
+The byte array to convert.
+
+#### Returns
+
+`string`
+
+The data as base64 string.

package/docs/reference/classes/Base64Url.md

@@ -0,0 +1,54 @@
+# Class: Base64Url
+
+Class to help with base64 URL Encoding/Decoding.
+https://www.rfc-editor.org/rfc/rfc4648#section-5.
+
+## Constructors
+
+### new Base64Url()
+
+> **new Base64Url**(): [`Base64Url`](Base64Url.md)
+
+#### Returns
+
+[`Base64Url`](Base64Url.md)
+
+## Methods
+
+### decode()
+
+> `static` **decode**(`base64Url`): `Uint8Array`
+
+Convert the base 64 string to a byte array.
+
+#### Parameters
+
+• **base64Url**: `string`
+
+The base64 url string to convert.
+
+#### Returns
+
+`Uint8Array`
+
+The byte array.
+
+***
+
+### encode()
+
+> `static` **encode**(`bytes`): `string`
+
+Convert a byte array to base 64 url.
+
+#### Parameters
+
+• **bytes**: `Uint8Array`
+
+The byte array to convert.
+
+#### Returns
+
+`string`
+
+The data as base64 url string.

package/docs/reference/classes/BaseError.md

@@ -0,0 +1,344 @@
+# Class: BaseError
+
+Class to handle errors.
+
+## Extends
+
+- `Error`
+
+## Extended by
+
+- [`AlreadyExistsError`](AlreadyExistsError.md)
+- [`ConflictError`](ConflictError.md)
+- [`GeneralError`](GeneralError.md)
+- [`GuardError`](GuardError.md)
+- [`NotFoundError`](NotFoundError.md)
+- [`NotImplementedError`](NotImplementedError.md)
+- [`NotSupportedError`](NotSupportedError.md)
+- [`UnauthorizedError`](UnauthorizedError.md)
+- [`UnprocessableError`](UnprocessableError.md)
+- [`ValidationError`](ValidationError.md)
+
+## Implements
+
+- [`IError`](../interfaces/IError.md)
+
+## Constructors
+
+### new BaseError()
+
+> **new BaseError**(`name`, `source`, `message`, `properties`?, `inner`?): [`BaseError`](BaseError.md)
+
+Create a new instance of BaseError.
+
+#### Parameters
+
+• **name**: `string`
+
+The name of the error.
+
+• **source**: `string`
+
+The source of the error.
+
+• **message**: `string`
+
+The message as a code.
+
+• **properties?**
+
+Any additional information for the error.
+
+• **inner?**: `unknown`
+
+The inner error if we have wrapped another error.
+
+#### Returns
+
+[`BaseError`](BaseError.md)
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### source?
+
+> `optional` **source**: `string`
+
+The source of the error.
+
+#### Implementation of
+
+[`IError`](../interfaces/IError.md).[`source`](../interfaces/IError.md#source)
+
+***
+
+### properties?
+
+> `optional` **properties**: `object`
+
+Any additional information for the error.
+
+#### Index Signature
+
+ \[`id`: `string`\]: `unknown`
+
+#### Implementation of
+
+[`IError`](../interfaces/IError.md).[`properties`](../interfaces/IError.md#properties)
+
+***
+
+### inner?
+
+> `optional` **inner**: [`IError`](../interfaces/IError.md)
+
+The inner error if there was one.
+
+#### Implementation of
+
+[`IError`](../interfaces/IError.md).[`inner`](../interfaces/IError.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.
+
+***
+
+### 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.
+
+***
+
+### 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.
+
+***
+
+### 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.
+
+***
+
+### 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.
+
+***
+
+### 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.
+
+***
+
+### 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.
+
+***
+
+### 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.
+
+***
+
+### 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.
+
+***
+
+### 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.
+
+***
+
+### toJsonObject()
+
+> **toJsonObject**(): [`IError`](../interfaces/IError.md)
+
+Serialize the error to the error model.
+
+#### Returns
+
+[`IError`](../interfaces/IError.md)
+
+The error model.