@twin.org/core 0.0.3-next.22 → 0.0.3-next.24

package/docs/reference/classes/ValidationError.md

@@ -44,9 +44,9 @@ The validation failures.
 
 ## Properties
 
-### source?
+### source? {#source}
 
-> `optional` **source**: `string`
+> `optional` **source?**: `string`
 
 The source of the error.
 
@@ -56,9 +56,9 @@ The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Any additional information for the error.
 
@@ -72,9 +72,9 @@ Any additional information for the error.
 
 ***
 
-### cause?
+### cause? {#cause}
 
-> `optional` **cause**: [`IError`](../interfaces/IError.md)
+> `optional` **cause?**: [`IError`](../interfaces/IError.md)
 
 The cause of the error.
 
@@ -84,7 +84,7 @@ The cause of the error.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -92,7 +92,7 @@ Runtime name for the class.s
 
 ## Methods
 
-### fromError()
+### fromError() {#fromerror}
 
 > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
 
@@ -118,7 +118,7 @@ The new instance.
 
 ***
 
-### flatten()
+### flatten() {#flatten}
 
 > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
 
@@ -144,7 +144,7 @@ The list of all internal errors.
 
 ***
 
-### expand()
+### expand() {#expand}
 
 > `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
@@ -154,9 +154,9 @@ Expand an error tree.
 
 ##### errors
 
-The list of errors to expand.
+[`IError`](../interfaces/IError.md)[] \| `undefined`
 
-[`IError`](../interfaces/IError.md)[] | `undefined`
+The list of errors to expand.
 
 #### Returns
 
@@ -170,7 +170,7 @@ The first level error.
 
 ***
 
-### isErrorName()
+### isErrorName() {#iserrorname}
 
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
 
@@ -186,9 +186,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -202,7 +202,7 @@ True if the error has the name.
 
 ***
 
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -218,9 +218,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -234,7 +234,7 @@ True if the error has the name.
 
 ***
 
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 
 > `static` **isErrorCode**(`error`, `code`): `boolean`
 
@@ -250,9 +250,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -266,7 +266,7 @@ True if the error has the code.
 
 ***
 
-### someErrorName()
+### someErrorName() {#someerrorname}
 
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
 
@@ -282,9 +282,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -298,7 +298,7 @@ True if the error has the name.
 
 ***
 
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -314,9 +314,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -330,7 +330,7 @@ True if the error has the name.
 
 ***
 
-### someErrorClass()
+### someErrorClass() {#someerrorclass}
 
 > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
 
@@ -362,7 +362,7 @@ True if the error has the specific class.
 
 ***
 
-### someErrorCode()
+### someErrorCode() {#someerrorcode}
 
 > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
 
@@ -378,9 +378,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -394,7 +394,7 @@ True if the error has the name.
 
 ***
 
-### isEmpty()
+### isEmpty() {#isempty}
 
 > `static` **isEmpty**(`err`): `boolean`
 
@@ -420,7 +420,7 @@ True if the error is empty.
 
 ***
 
-### isAggregateError()
+### isAggregateError() {#isaggregateerror}
 
 > `static` **isAggregateError**(`err`): `err is AggregateError`
 
@@ -446,7 +446,7 @@ True if the error is an aggregate error.
 
 ***
 
-### fromAggregate()
+### fromAggregate() {#fromaggregate}
 
 > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
 
@@ -478,7 +478,7 @@ The array of errors.
 
 ***
 
-### toJsonObject()
+### toJsonObject() {#tojsonobject}
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 

package/docs/reference/index.md

@@ -61,6 +61,8 @@
 - [CoerceType](type-aliases/CoerceType.md)
 - [CompressionType](type-aliases/CompressionType.md)
 - [ObjectOrArray](type-aliases/ObjectOrArray.md)
+- [SingleOccurrenceArrayDepthHelper](type-aliases/SingleOccurrenceArrayDepthHelper.md)
+- [SingleOccurrenceArray](type-aliases/SingleOccurrenceArray.md)
 
 ## Variables
 

package/docs/reference/interfaces/IComponent.md

@@ -4,7 +4,7 @@ Interface describing a component which can be bootstrapped, started and stopped.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -18,7 +18,7 @@ The class name of the component.
 
 ***
 
-### bootstrap()?
+### bootstrap()? {#bootstrap}
 
 > `optional` **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
 
@@ -40,7 +40,7 @@ True if the bootstrapping process was successful.
 
 ***
 
-### start()?
+### start()? {#start}
 
 > `optional` **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
 
@@ -62,7 +62,7 @@ Nothing.
 
 ***
 
-### stop()?
+### stop()? {#stop}
 
 > `optional` **stop**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
 

package/docs/reference/interfaces/IError.md

@@ -4,7 +4,7 @@ Model to describe serialized error.
 
 ## Properties
 
-### name
+### name {#name}
 
 > **name**: `string`
 
@@ -12,7 +12,7 @@ The name for the error.
 
 ***
 
-### message
+### message {#message}
 
 > **message**: `string`
 
@@ -20,17 +20,17 @@ The message for the error.
 
 ***
 
-### source?
+### source? {#source}
 
-> `optional` **source**: `string`
+> `optional` **source?**: `string`
 
 The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Any additional information for the error.
 
@@ -40,16 +40,16 @@ Any additional information for the error.
 
 ***
 
-### stack?
+### stack? {#stack}
 
-> `optional` **stack**: `string`
+> `optional` **stack?**: `string`
 
 The stack trace for the error.
 
 ***
 
-### cause?
+### cause? {#cause}
 
-> `optional` **cause**: `IError`
+> `optional` **cause?**: `IError`
 
 The cause of the error if there was one.

package/docs/reference/interfaces/II18nShared.md

@@ -4,7 +4,7 @@ The shared state for the I18n global.
 
 ## Properties
 
-### localeDictionaries
+### localeDictionaries {#localedictionaries}
 
 > **localeDictionaries**: `object`
 
@@ -16,7 +16,7 @@ Dictionaries for lookups.
 
 ***
 
-### currentLocale
+### currentLocale {#currentlocale}
 
 > **currentLocale**: `string`
 
@@ -24,7 +24,7 @@ The current locale.
 
 ***
 
-### localeChangedHandlers
+### localeChangedHandlers {#localechangedhandlers}
 
 > **localeChangedHandlers**: `object`
 
@@ -36,7 +36,7 @@ Change handler for the locale being updated.
 
 ***
 
-### dictionaryChangedHandlers
+### dictionaryChangedHandlers {#dictionarychangedhandlers}
 
 > **dictionaryChangedHandlers**: `object`
 

package/docs/reference/interfaces/IKeyValue.md

@@ -10,7 +10,7 @@ Interface describing a key/value pair.
 
 ## Properties
 
-### key
+### key {#key}
 
 > **key**: `string`
 
@@ -18,7 +18,7 @@ The key for the item.
 
 ***
 
-### value
+### value {#value}
 
 > **value**: `T`
 

package/docs/reference/interfaces/ILabelledValue.md

@@ -10,7 +10,7 @@ Interface describing a label/value pair.
 
 ## Properties
 
-### label
+### label {#label}
 
 > **label**: `string`
 
@@ -18,7 +18,7 @@ The label for the item.
 
 ***
 
-### value
+### value {#value}
 
 > **value**: `T`
 

package/docs/reference/interfaces/ILocale.md

@@ -4,7 +4,7 @@ Model for a local.
 
 ## Properties
 
-### label
+### label {#label}
 
 > **label**: `string`
 
@@ -12,7 +12,7 @@ The label.
 
 ***
 
-### code
+### code {#code}
 
 > **code**: `string`
 

package/docs/reference/interfaces/ILocaleDictionary.md

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

package/docs/reference/interfaces/ILocalesIndex.md

@@ -4,7 +4,7 @@ Model for a locales index.
 
 ## Properties
 
-### locales
+### locales {#locales}
 
 > **locales**: [`ILocale`](ILocale.md)[]
 

package/docs/reference/interfaces/IPatchOperation.md

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

package/docs/reference/interfaces/IUrlParts.md

@@ -4,7 +4,7 @@ Model to describe the parts of a url.
 
 ## Properties
 
-### schema
+### schema {#schema}
 
 > **schema**: `string`
 
@@ -12,7 +12,7 @@ The schema for the url.
 
 ***
 
-### host
+### host {#host}
 
 > **host**: `string`
 
@@ -20,15 +20,15 @@ The host for the url.
 
 ***
 
-### port?
+### port? {#port}
 
-> `optional` **port**: `number`
+> `optional` **port?**: `number`
 
 The port for the url.
 
 ***
 
-### path
+### path {#path}
 
 > **path**: `string`
 
@@ -36,16 +36,16 @@ The path for the url.
 
 ***
 
-### params?
+### params? {#params}
 
-> `optional` **params**: `string`
+> `optional` **params?**: `string`
 
 The params for the url.
 
 ***
 
-### hash?
+### hash? {#hash}
 
-> `optional` **hash**: `string`
+> `optional` **hash?**: `string`
 
 The hash for the url.

package/docs/reference/interfaces/IValidationFailure.md

@@ -4,7 +4,7 @@ Interface describing the reason a validation failed.
 
 ## Properties
 
-### property
+### property {#property}
 
 > **property**: `string`
 
@@ -12,7 +12,7 @@ The property that failed validation.
 
 ***
 
-### reason
+### reason {#reason}
 
 > **reason**: `string`
 
@@ -20,9 +20,9 @@ The reason the validation failed as an i18 resource error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Additional properties for the validation failure.
 

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

@@ -0,0 +1,15 @@
+# Type Alias: SingleOccurrenceArray\<T, U\>
+
+> **SingleOccurrenceArray**\<`T`, `U`\> = [`SingleOccurrenceArrayDepthHelper`](SingleOccurrenceArrayDepthHelper.md)\<`T`, `U`, \[\]\>
+
+Utility type to create a non-empty array with values of type T and exactly one value of type U.
+
+## Type Parameters
+
+### T
+
+`T` = `unknown`
+
+### U
+
+`U` = `never`

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

@@ -0,0 +1,19 @@
+# Type Alias: SingleOccurrenceArrayDepthHelper\<T, U, Depth\>
+
+> **SingleOccurrenceArrayDepthHelper**\<`T`, `U`, `Depth`\> = `Depth`\[`"length"`\] *extends* `16` ? \[`U`, `...T[]`\] : \[`U`, `...T[]`\] \| \[`T`, `...SingleOccurrenceArrayDepthHelper<T, U, [0, ...Depth]>`\]
+
+Helper with bounded recursion depth to keep type instantiation tractable.
+
+## Type Parameters
+
+### T
+
+`T`
+
+### U
+
+`U`
+
+### Depth
+
+`Depth` *extends* `0`[]

package/docs/reference/variables/CoerceType.md

@@ -6,61 +6,61 @@ The types the extracted data can be coerced to.
 
 ## Type Declaration
 
-### String
+### String {#string}
 
 > `readonly` **String**: `"string"` = `"string"`
 
 String.
 
-### Number
+### Number {#number}
 
 > `readonly` **Number**: `"number"` = `"number"`
 
 Number.
 
-### Integer
+### Integer {#integer}
 
 > `readonly` **Integer**: `"integer"` = `"integer"`
 
 Integer.
 
-### Boolean
+### Boolean {#boolean}
 
 > `readonly` **Boolean**: `"boolean"` = `"boolean"`
 
 Boolean.
 
-### BigInt
+### BigInt {#bigint}
 
 > `readonly` **BigInt**: `"bigint"` = `"bigint"`
 
 Big Integer.
 
-### Date
+### Date {#date}
 
 > `readonly` **Date**: `"date"` = `"date"`
 
 Date.
 
-### DateTime
+### DateTime {#datetime}
 
 > `readonly` **DateTime**: `"datetime"` = `"datetime"`
 
 Date Time.
 
-### Time
+### Time {#time}
 
 > `readonly` **Time**: `"time"` = `"time"`
 
 Time.
 
-### Object
+### Object {#object}
 
 > `readonly` **Object**: `"object"` = `"object"`
 
 Object.
 
-### Uint8Array
+### Uint8Array {#uint8array}
 
 > `readonly` **Uint8Array**: `"uint8array"` = `"uint8array"`