@twin.org/core 0.0.3-next.21 → 0.0.3-next.23

package/docs/reference/classes/Validation.md

@@ -14,7 +14,7 @@ Class to handle validation operations.
 
 ## Methods
 
-### empty()
+### empty() {#empty}
 
 > `static` **empty**(`property`, `value`, `failures`, `fieldNameResource?`): value is null \| undefined
 
@@ -54,7 +54,7 @@ True if the value is a empty.
 
 ***
 
-### notEmpty()
+### notEmpty() {#notempty}
 
 > `static` **notEmpty**(`property`, `value`, `failures`, `fieldNameResource?`): `boolean`
 
@@ -94,7 +94,7 @@ True if the value is a not empty.
 
 ***
 
-### string()
+### string() {#string}
 
 > `static` **string**(`property`, `value`, `failures`, `fieldNameResource?`, `options?`): `value is string`
 
@@ -156,7 +156,7 @@ True if the value is a valid string.
 
 ***
 
-### stringValue()
+### stringValue() {#stringvalue}
 
 > `static` **stringValue**(`property`, `value`, `failures`, `fieldNameResource?`, `options?`): `value is string`
 
@@ -212,7 +212,7 @@ True if the value is a valid string.
 
 ***
 
-### number()
+### number() {#number}
 
 > `static` **number**(`property`, `value`, `failures`, `fieldNameResource?`, `options?`): `value is number`
 
@@ -268,7 +268,7 @@ True if the value is a valid number.
 
 ***
 
-### integer()
+### integer() {#integer}
 
 > `static` **integer**(`property`, `value`, `failures`, `fieldNameResource?`, `options?`): `value is number`
 
@@ -324,7 +324,7 @@ True if the value is a valid integer.
 
 ***
 
-### bigint()
+### bigint() {#bigint}
 
 > `static` **bigint**(`property`, `value`, `failures`, `fieldNameResource?`, `options?`): `value is bigint`
 
@@ -380,7 +380,7 @@ True if the value is a valid bigint.
 
 ***
 
-### boolean()
+### boolean() {#boolean}
 
 > `static` **boolean**(`property`, `value`, `failures`, `fieldNameResource?`): `value is boolean`
 
@@ -420,7 +420,7 @@ True if the value is a boolean.
 
 ***
 
-### date()
+### date() {#date}
 
 > `static` **date**(`property`, `value`, `failures`, `fieldNameResource?`): `value is Date`
 
@@ -460,7 +460,7 @@ True if the value is a date.
 
 ***
 
-### dateString()
+### dateString() {#datestring}
 
 > `static` **dateString**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
@@ -500,7 +500,7 @@ True if the value is a date.
 
 ***
 
-### dateTimeString()
+### dateTimeString() {#datetimestring}
 
 > `static` **dateTimeString**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
@@ -540,7 +540,7 @@ True if the value is a date/time.
 
 ***
 
-### timeString()
+### timeString() {#timestring}
 
 > `static` **timeString**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
@@ -580,7 +580,7 @@ True if the value is a time.
 
 ***
 
-### timestampMilliseconds()
+### timestampMilliseconds() {#timestampmilliseconds}
 
 > `static` **timestampMilliseconds**(`property`, `value`, `failures`, `fieldNameResource?`): `value is number`
 
@@ -620,7 +620,7 @@ True if the value is a timestamp in milliseconds.
 
 ***
 
-### timestampSeconds()
+### timestampSeconds() {#timestampseconds}
 
 > `static` **timestampSeconds**(`property`, `value`, `failures`, `fieldNameResource?`): `value is number`
 
@@ -660,7 +660,7 @@ True if the value is a timestamp in seconds.
 
 ***
 
-### object()
+### object() {#object}
 
 > `static` **object**\<`T`\>(`property`, `value`, `failures`, `fieldNameResource?`): `value is T`
 
@@ -706,7 +706,7 @@ True if the value is a object.
 
 ***
 
-### array()
+### array() {#array}
 
 > `static` **array**\<`T`\>(`property`, `value`, `failures`, `fieldNameResource?`): `value is T[]`
 
@@ -752,7 +752,7 @@ True if the value is an array.
 
 ***
 
-### arrayValue()
+### arrayValue() {#arrayvalue}
 
 > `static` **arrayValue**\<`T`\>(`property`, `value`, `failures`, `fieldNameResource?`): `value is T[]`
 
@@ -798,7 +798,7 @@ True if the value is an array with at least one element.
 
 ***
 
-### arrayOneOf()
+### arrayOneOf() {#arrayoneof}
 
 > `static` **arrayOneOf**\<`T`\>(`property`, `value`, `options`, `failures`, `fieldNameResource?`): `value is T`
 
@@ -850,7 +850,7 @@ True if the value is one of the items in the options.
 
 ***
 
-### uint8Array()
+### uint8Array() {#uint8array}
 
 > `static` **uint8Array**(`property`, `value`, `failures`, `fieldNameResource?`): `value is Uint8Array<ArrayBufferLike>`
 
@@ -890,7 +890,7 @@ True if the value is a Uint8Array.
 
 ***
 
-### json()
+### json() {#json}
 
 > `static` **json**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
@@ -930,7 +930,7 @@ True if the value is valid JSON.
 
 ***
 
-### email()
+### email() {#email}
 
 > `static` **email**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
@@ -970,7 +970,7 @@ True if the value is a valid looking e-mail.
 
 ***
 
-### asValidationError()
+### asValidationError() {#asvalidationerror}
 
 > `static` **asValidationError**(`source`, `objectName`, `failures`): `void`
 
@@ -1006,9 +1006,9 @@ ValidationError From the converted failures.
 
 ***
 
-### toPropertyMap()
+### toPropertyMap() {#topropertymap}
 
-> `static` **toPropertyMap**(`failures`, `propertyMap`, `clearMap`): `void`
+> `static` **toPropertyMap**(`failures`, `propertyMap`, `clearMap?`): `void`
 
 Map a list of failures to their properties in a map.
 
@@ -1024,7 +1024,7 @@ The validation failures to combine into the map for the properties.
 
 The map to add the failures to.
 
-##### clearMap
+##### clearMap?
 
 `boolean` = `true`
 

package/docs/reference/classes/ValidationError.md

@@ -44,7 +44,7 @@ The validation failures.
 
 ## Properties
 
-### source?
+### source? {#source}
 
 > `optional` **source**: `string`
 
@@ -56,7 +56,7 @@ The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
 > `optional` **properties**: `object`
 
@@ -72,7 +72,7 @@ Any additional information for the error.
 
 ***
 
-### cause?
+### cause? {#cause}
 
 > `optional` **cause**: [`IError`](../interfaces/IError.md)
 
@@ -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`
 
@@ -170,7 +170,7 @@ The first level error.
 
 ***
 
-### isErrorName()
+### isErrorName() {#iserrorname}
 
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
 
@@ -202,7 +202,7 @@ True if the error has the name.
 
 ***
 
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -234,7 +234,7 @@ True if the error has the name.
 
 ***
 
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 
 > `static` **isErrorCode**(`error`, `code`): `boolean`
 
@@ -266,7 +266,7 @@ True if the error has the code.
 
 ***
 
-### someErrorName()
+### someErrorName() {#someerrorname}
 
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
 
@@ -298,7 +298,7 @@ True if the error has the name.
 
 ***
 
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -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`
 
@@ -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,7 +20,7 @@ The message for the error.
 
 ***
 
-### source?
+### source? {#source}
 
 > `optional` **source**: `string`
 
@@ -28,7 +28,7 @@ The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
 > `optional` **properties**: `object`
 
@@ -40,7 +40,7 @@ Any additional information for the error.
 
 ***
 
-### stack?
+### stack? {#stack}
 
 > `optional` **stack**: `string`
 
@@ -48,7 +48,7 @@ The stack trace for the error.
 
 ***
 
-### cause?
+### cause? {#cause}
 
 > `optional` **cause**: `IError`
 

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/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,7 +20,7 @@ The path to the object that was changed.
 
 ***
 
-### from?
+### from? {#from}
 
 > `optional` **from**: `string`
 
@@ -28,7 +28,7 @@ The path the value was copied or moved from.
 
 ***
 
-### value?
+### value? {#value}
 
 > `optional` **value**: `unknown`
 

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,7 +20,7 @@ The host for the url.
 
 ***
 
-### port?
+### port? {#port}
 
 > `optional` **port**: `number`
 
@@ -28,7 +28,7 @@ The port for the url.
 
 ***
 
-### path
+### path {#path}
 
 > **path**: `string`
 
@@ -36,7 +36,7 @@ The path for the url.
 
 ***
 
-### params?
+### params? {#params}
 
 > `optional` **params**: `string`
 
@@ -44,7 +44,7 @@ The params for the url.
 
 ***
 
-### hash?
+### hash? {#hash}
 
 > `optional` **hash**: `string`
 

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,7 +20,7 @@ The reason the validation failed as an i18 resource error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
 > `optional` **properties**: `object`
 

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`