npm - @twin.org/core - Versions diffs - 0.0.1-next.9 → 0.0.2-next.10 - Mend

@twin.org/core 0.0.1-next.9 → 0.0.2-next.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (85) hide show

package/dist/cjs/index.cjs +2266 -1470
package/dist/esm/index.mjs +2263 -1471
package/dist/types/errors/alreadyExistsError.d.ts +2 -2
package/dist/types/errors/baseError.d.ts +25 -5
package/dist/types/errors/conflictError.d.ts +2 -2
package/dist/types/errors/generalError.d.ts +2 -2
package/dist/types/errors/notFoundError.d.ts +2 -2
package/dist/types/errors/notSupportedError.d.ts +2 -2
package/dist/types/errors/unauthorizedError.d.ts +2 -2
package/dist/types/errors/unprocessableError.d.ts +2 -2
package/dist/types/factories/factory.d.ts +21 -2
package/dist/types/helpers/arrayHelper.d.ts +13 -0
package/dist/types/helpers/envHelper.d.ts +16 -0
package/dist/types/helpers/errorHelper.d.ts +5 -4
package/dist/types/helpers/jsonHelper.d.ts +30 -0
package/dist/types/helpers/objectHelper.d.ts +25 -0
package/dist/types/helpers/uint8ArrayHelper.d.ts +11 -0
package/dist/types/index.d.ts +6 -0
package/dist/types/models/IComponent.d.ts +6 -6
package/dist/types/models/IError.d.ts +2 -2
package/dist/types/models/II18nShared.d.ts +29 -0
package/dist/types/models/coerceType.d.ts +49 -0
package/dist/types/models/compressionType.d.ts +1 -1
package/dist/types/models/objectOrArray.d.ts +4 -0
package/dist/types/utils/asyncCache.d.ts +10 -1
package/dist/types/utils/coerce.d.ts +22 -0
package/dist/types/utils/guards.d.ts +35 -0
package/dist/types/utils/is.d.ts +18 -0
package/dist/types/utils/sharedStore.d.ts +23 -0
package/dist/types/utils/validation.d.ts +2 -0
package/docs/changelog.md +442 -1
package/docs/reference/classes/AlreadyExistsError.md +166 -32
package/docs/reference/classes/ArrayHelper.md +71 -5
package/docs/reference/classes/AsyncCache.md +75 -13
package/docs/reference/classes/Base32.md +9 -5
package/docs/reference/classes/Base58.md +9 -5
package/docs/reference/classes/Base64.md +12 -6
package/docs/reference/classes/Base64Url.md +9 -5
package/docs/reference/classes/BaseError.md +160 -34
package/docs/reference/classes/BitString.md +23 -11
package/docs/reference/classes/Coerce.md +110 -12
package/docs/reference/classes/Compression.md +19 -11
package/docs/reference/classes/ConflictError.md +169 -33
package/docs/reference/classes/Converter.md +72 -28
package/docs/reference/classes/EnvHelper.md +45 -0
package/docs/reference/classes/ErrorHelper.md +22 -10
package/docs/reference/classes/Factory.md +96 -18
package/docs/reference/classes/FilenameHelper.md +6 -4
package/docs/reference/classes/GeneralError.md +164 -32
package/docs/reference/classes/GuardError.md +168 -32
package/docs/reference/classes/Guards.md +398 -80
package/docs/reference/classes/HexHelper.md +18 -8
package/docs/reference/classes/I18n.md +46 -20
package/docs/reference/classes/Is.md +207 -51
package/docs/reference/classes/JsonHelper.md +146 -10
package/docs/reference/classes/NotFoundError.md +166 -32
package/docs/reference/classes/NotImplementedError.md +159 -29
package/docs/reference/classes/NotSupportedError.md +163 -31
package/docs/reference/classes/ObjectHelper.md +197 -39
package/docs/reference/classes/RandomHelper.md +6 -4
package/docs/reference/classes/SharedStore.md +94 -0
package/docs/reference/classes/StringHelper.md +54 -20
package/docs/reference/classes/Uint8ArrayHelper.md +35 -0
package/docs/reference/classes/UnauthorizedError.md +163 -31
package/docs/reference/classes/UnprocessableError.md +164 -32
package/docs/reference/classes/Url.md +37 -17
package/docs/reference/classes/Urn.md +63 -27
package/docs/reference/classes/Validation.md +349 -135
package/docs/reference/classes/ValidationError.md +162 -30
package/docs/reference/index.md +7 -0
package/docs/reference/interfaces/IComponent.md +21 -11
package/docs/reference/interfaces/IError.md +4 -4
package/docs/reference/interfaces/II18nShared.md +47 -0
package/docs/reference/interfaces/IKeyValue.md +3 -1
package/docs/reference/interfaces/ILabelledValue.md +3 -1
package/docs/reference/interfaces/ILocaleDictionary.md +1 -1
package/docs/reference/interfaces/IPatchOperation.md +1 -1
package/docs/reference/interfaces/IValidationFailure.md +1 -1
package/docs/reference/type-aliases/CoerceType.md +5 -0
package/docs/reference/type-aliases/CompressionType.md +1 -1
package/docs/reference/type-aliases/ObjectOrArray.md +11 -0
package/docs/reference/variables/CoerceType.md +67 -0
package/docs/reference/variables/CompressionType.md +2 -2
package/locales/en.json +14 -1
package/package.json +7 -7

package/docs/reference/classes/NotImplementedError.md CHANGED Viewed

@@ -8,29 +8,33 @@ Class to handle errors.
 ## Constructors
-### new NotImplementedError()
+### Constructor
-> **new NotImplementedError**(`source`, `method`): [`NotImplementedError`](NotImplementedError.md)
+> **new NotImplementedError**(`source`, `method`): `NotImplementedError`
 Create a new instance of NotImplementedError.
 #### Parameters
-• **source**: `string`
+##### source
+`string`
 The source of the error.
-• **method**: `string`
+##### method
+`string`
 The method for the error.
 #### Returns
-[`NotImplementedError`](NotImplementedError.md)
+`NotImplementedError`
 #### Overrides
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructor)
 ## Properties
@@ -54,7 +58,7 @@ Any additional information for the error.
 #### Index Signature
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 #### Inherited from
@@ -62,15 +66,15 @@ Any additional information for the error.
 ***
-### inner?
+### cause?
-> `optional` **inner**: [`IError`](../interfaces/IError.md)
+> `optional` **cause**: [`IError`](../interfaces/IError.md)
-The inner error if there was one.
+The cause of the error.
 #### Inherited from
-[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
+[`BaseError`](BaseError.md).[`cause`](BaseError.md#cause)
 ***
@@ -90,7 +94,9 @@ Construct an error from an existing one.
 #### Parameters
-• **err**: `unknown`
+##### err
+`unknown`
 The existing error.
@@ -114,7 +120,9 @@ Flatten an error tree.
 #### Parameters
-• **err**: `unknown`
+##### err
+`unknown`
 The starting error.
@@ -138,10 +146,12 @@ Expand an error tree.
 #### Parameters
-• **errors**: `undefined` \| [`IError`](../interfaces/IError.md)[]
+##### errors
 The list of errors to expand.
+`undefined` | [`IError`](../interfaces/IError.md)[]
 #### Returns
 `undefined` \| [`IError`](../interfaces/IError.md)
@@ -162,14 +172,18 @@ Test to see if the error has the specified error name.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **name**: `string` \| `RegExp`
+##### name
 The name to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -190,14 +204,18 @@ Test to see if the error has the specified error message.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **message**: `string` \| `RegExp`
+##### message
 The message to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -218,14 +236,18 @@ Test to see if the error has the specified error code.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **code**: `string` \| `RegExp`
+##### code
 The code to check for.
+`string` | `RegExp`
 #### Returns
 `boolean`
@@ -246,14 +268,18 @@ Test to see if any of the errors or children have the given error name.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **name**: `string` \| `RegExp`
+##### name
 The name to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -274,14 +300,18 @@ Test to see if any of the errors or children have the given error message.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **message**: `string` \| `RegExp`
+##### message
 The message to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -302,11 +332,15 @@ Test to see if any of the errors or children are from a specific class.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **cls**: `string`
+##### cls
+`string`
 The class to check for.
@@ -330,14 +364,18 @@ Test to see if any of the errors or children have the given error code.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **code**: `string` \| `RegExp`
+##### code
 The code to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -350,12 +388,104 @@ True if the error has the name.
 ***
+### isEmpty()
+> `static` **isEmpty**(`err`): `boolean`
+Is the error empty, i.e. does it have no message, source, properties, or cause?
+#### Parameters
+##### err
+[`IError`](../interfaces/IError.md)
+The error to check for being empty.
+#### Returns
+`boolean`
+True if the error is empty.
+#### Inherited from
+[`BaseError`](BaseError.md).[`isEmpty`](BaseError.md#isempty)
+***
+### isAggregateError()
+> `static` **isAggregateError**(`err`): `err is AggregateError`
+Is the error an aggregate error.
+#### Parameters
+##### err
+`unknown`
+The error to check for being an aggregate error.
+#### Returns
+`err is AggregateError`
+True if the error is an aggregate error.
+#### Inherited from
+[`BaseError`](BaseError.md).[`isAggregateError`](BaseError.md#isaggregateerror)
+***
+### fromAggregate()
+> `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
+Convert the aggregate error to an array of errors.
+#### Parameters
+##### err
+`unknown`
+The error to convert.
+##### includeStackTrace?
+`boolean`
+Whether to include the error stack in the model, defaults to false.
+#### Returns
+[`IError`](../interfaces/IError.md)[]
+The array of errors.
+#### Inherited from
+[`BaseError`](BaseError.md).[`fromAggregate`](BaseError.md#fromaggregate)
+***
 ### toJsonObject()
-> **toJsonObject**(): [`IError`](../interfaces/IError.md)
+> **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 Serialize the error to the error model.
+#### Parameters
+##### includeStackTrace?
+`boolean`
+Whether to include the error stack in the model, defaults to false.
 #### Returns
 [`IError`](../interfaces/IError.md)

package/docs/reference/classes/NotSupportedError.md CHANGED Viewed

@@ -8,33 +8,39 @@ Class to handle errors when a feature is unsupported.
 ## Constructors
-### new NotSupportedError()
+### Constructor
-> **new NotSupportedError**(`source`, `message`, `inner`?): [`NotSupportedError`](NotSupportedError.md)
+> **new NotSupportedError**(`source`, `message`, `cause?`): `NotSupportedError`
 Create a new instance of NotSupportedError.
 #### Parameters
-• **source**: `string`
+##### source
+`string`
 The source of the error.
-• **message**: `string`
+##### message
+`string`
 The message as a code.
-• **inner?**: `unknown`
+##### cause?
+`unknown`
-The inner error if we have wrapped another error.
+The cause of the error if we have wrapped another error.
 #### Returns
-[`NotSupportedError`](NotSupportedError.md)
+`NotSupportedError`
 #### Overrides
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructor)
 ## Properties
@@ -58,7 +64,7 @@ Any additional information for the error.
 #### Index Signature
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 #### Inherited from
@@ -66,15 +72,15 @@ Any additional information for the error.
 ***
-### inner?
+### cause?
-> `optional` **inner**: [`IError`](../interfaces/IError.md)
+> `optional` **cause**: [`IError`](../interfaces/IError.md)
-The inner error if there was one.
+The cause of the error.
 #### Inherited from
-[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
+[`BaseError`](BaseError.md).[`cause`](BaseError.md#cause)
 ***
@@ -94,7 +100,9 @@ Construct an error from an existing one.
 #### Parameters
-• **err**: `unknown`
+##### err
+`unknown`
 The existing error.
@@ -118,7 +126,9 @@ Flatten an error tree.
 #### Parameters
-• **err**: `unknown`
+##### err
+`unknown`
 The starting error.
@@ -142,10 +152,12 @@ Expand an error tree.
 #### Parameters
-• **errors**: `undefined` \| [`IError`](../interfaces/IError.md)[]
+##### errors
 The list of errors to expand.
+`undefined` | [`IError`](../interfaces/IError.md)[]
 #### Returns
 `undefined` \| [`IError`](../interfaces/IError.md)
@@ -166,14 +178,18 @@ Test to see if the error has the specified error name.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **name**: `string` \| `RegExp`
+##### name
 The name to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -194,14 +210,18 @@ Test to see if the error has the specified error message.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **message**: `string` \| `RegExp`
+##### message
 The message to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -222,14 +242,18 @@ Test to see if the error has the specified error code.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **code**: `string` \| `RegExp`
+##### code
 The code to check for.
+`string` | `RegExp`
 #### Returns
 `boolean`
@@ -250,14 +274,18 @@ Test to see if any of the errors or children have the given error name.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **name**: `string` \| `RegExp`
+##### name
 The name to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -278,14 +306,18 @@ Test to see if any of the errors or children have the given error message.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **message**: `string` \| `RegExp`
+##### message
 The message to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -306,11 +338,15 @@ Test to see if any of the errors or children are from a specific class.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **cls**: `string`
+##### cls
+`string`
 The class to check for.
@@ -334,14 +370,18 @@ Test to see if any of the errors or children have the given error code.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **code**: `string` \| `RegExp`
+##### code
 The code to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -354,12 +394,104 @@ True if the error has the name.
 ***
+### isEmpty()
+> `static` **isEmpty**(`err`): `boolean`
+Is the error empty, i.e. does it have no message, source, properties, or cause?
+#### Parameters
+##### err
+[`IError`](../interfaces/IError.md)
+The error to check for being empty.
+#### Returns
+`boolean`
+True if the error is empty.
+#### Inherited from
+[`BaseError`](BaseError.md).[`isEmpty`](BaseError.md#isempty)
+***
+### isAggregateError()
+> `static` **isAggregateError**(`err`): `err is AggregateError`
+Is the error an aggregate error.
+#### Parameters
+##### err
+`unknown`
+The error to check for being an aggregate error.
+#### Returns
+`err is AggregateError`
+True if the error is an aggregate error.
+#### Inherited from
+[`BaseError`](BaseError.md).[`isAggregateError`](BaseError.md#isaggregateerror)
+***
+### fromAggregate()
+> `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
+Convert the aggregate error to an array of errors.
+#### Parameters
+##### err
+`unknown`
+The error to convert.
+##### includeStackTrace?
+`boolean`
+Whether to include the error stack in the model, defaults to false.
+#### Returns
+[`IError`](../interfaces/IError.md)[]
+The array of errors.
+#### Inherited from
+[`BaseError`](BaseError.md).[`fromAggregate`](BaseError.md#fromaggregate)
+***
 ### toJsonObject()
-> **toJsonObject**(): [`IError`](../interfaces/IError.md)
+> **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 Serialize the error to the error model.
+#### Parameters
+##### includeStackTrace?
+`boolean`
+Whether to include the error stack in the model, defaults to false.
 #### Returns
 [`IError`](../interfaces/IError.md)