npm - @twin.org/core - Versions diffs - 0.0.3-next.9 → 0.0.3 - Mend

@twin.org/core 0.0.3-next.9 → 0.0.3

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 (156) hide show

package/README.md +1 -9
package/dist/es/encoding/base32.js +1 -1
package/dist/es/encoding/base32.js.map +1 -1
package/dist/es/encoding/base64.js +1 -1
package/dist/es/encoding/base64.js.map +1 -1
package/dist/es/errors/alreadyExistsError.js +1 -1
package/dist/es/errors/alreadyExistsError.js.map +1 -1
package/dist/es/errors/baseError.js +1 -1
package/dist/es/errors/baseError.js.map +1 -1
package/dist/es/errors/conflictError.js +1 -1
package/dist/es/errors/conflictError.js.map +1 -1
package/dist/es/errors/generalError.js +1 -1
package/dist/es/errors/generalError.js.map +1 -1
package/dist/es/errors/guardError.js +1 -1
package/dist/es/errors/guardError.js.map +1 -1
package/dist/es/errors/notFoundError.js +1 -1
package/dist/es/errors/notFoundError.js.map +1 -1
package/dist/es/errors/notSupportedError.js +1 -1
package/dist/es/errors/notSupportedError.js.map +1 -1
package/dist/es/errors/unauthorizedError.js +2 -2
package/dist/es/errors/unauthorizedError.js.map +1 -1
package/dist/es/errors/unprocessableError.js +1 -1
package/dist/es/errors/unprocessableError.js.map +1 -1
package/dist/es/factories/factory.js +41 -0
package/dist/es/factories/factory.js.map +1 -1
package/dist/es/helpers/arrayHelper.js +2 -0
package/dist/es/helpers/arrayHelper.js.map +1 -1
package/dist/es/helpers/errorHelper.js +18 -14
package/dist/es/helpers/errorHelper.js.map +1 -1
package/dist/es/helpers/jsonHelper.js.map +1 -1
package/dist/es/helpers/objectHelper.js +12 -36
package/dist/es/helpers/objectHelper.js.map +1 -1
package/dist/es/helpers/stringHelper.js +11 -0
package/dist/es/helpers/stringHelper.js.map +1 -1
package/dist/es/index.js +8 -1
package/dist/es/index.js.map +1 -1
package/dist/es/models/IComponent.js +0 -2
package/dist/es/models/IComponent.js.map +1 -1
package/dist/es/models/IError.js.map +1 -1
package/dist/es/models/IHealth.js +2 -0
package/dist/es/models/IHealth.js.map +1 -0
package/dist/es/models/IMutexWorkerMessage.js +2 -0
package/dist/es/models/IMutexWorkerMessage.js.map +1 -0
package/dist/es/models/healthStatus.js +21 -0
package/dist/es/models/healthStatus.js.map +1 -0
package/dist/es/models/mutexMessageTypes.js +13 -0
package/dist/es/models/mutexMessageTypes.js.map +1 -0
package/dist/es/types/objectOrArray.js.map +1 -0
package/dist/es/types/singleOccurrenceArray.js +2 -0
package/dist/es/types/singleOccurrenceArray.js.map +1 -0
package/dist/es/types/singleOccurrenceArrayDepthHelper.js +2 -0
package/dist/es/types/singleOccurrenceArrayDepthHelper.js.map +1 -0
package/dist/es/types/urn.js +1 -2
package/dist/es/types/urn.js.map +1 -1
package/dist/es/utils/asyncCache.js +236 -88
package/dist/es/utils/asyncCache.js.map +1 -1
package/dist/es/utils/guards.js.map +1 -1
package/dist/es/utils/i18n.js.map +1 -1
package/dist/es/utils/mutex.js +185 -0
package/dist/es/utils/mutex.js.map +1 -0
package/dist/types/encoding/base32.d.ts +1 -1
package/dist/types/errors/alreadyExistsError.d.ts +1 -1
package/dist/types/errors/baseError.d.ts +1 -1
package/dist/types/errors/conflictError.d.ts +1 -1
package/dist/types/errors/generalError.d.ts +1 -1
package/dist/types/errors/guardError.d.ts +1 -1
package/dist/types/errors/notFoundError.d.ts +1 -1
package/dist/types/errors/notSupportedError.d.ts +1 -1
package/dist/types/errors/unauthorizedError.d.ts +2 -2
package/dist/types/errors/unprocessableError.d.ts +1 -1
package/dist/types/factories/factory.d.ts +23 -1
package/dist/types/helpers/arrayHelper.d.ts +1 -8
package/dist/types/helpers/errorHelper.d.ts +11 -4
package/dist/types/helpers/objectHelper.d.ts +18 -14
package/dist/types/helpers/stringHelper.d.ts +6 -0
package/dist/types/index.d.ts +8 -1
package/dist/types/models/IComponent.d.ts +12 -0
package/dist/types/models/IError.d.ts +1 -1
package/dist/types/models/IHealth.d.ts +32 -0
package/dist/types/models/IMutexWorkerMessage.d.ts +23 -0
package/dist/types/models/healthStatus.d.ts +21 -0
package/dist/types/models/mutexMessageTypes.d.ts +13 -0
package/dist/types/types/singleOccurrenceArray.d.ts +6 -0
package/dist/types/types/singleOccurrenceArrayDepthHelper.d.ts +4 -0
package/dist/types/utils/asyncCache.d.ts +11 -3
package/dist/types/utils/guards.d.ts +1 -1
package/dist/types/utils/mutex.d.ts +53 -0
package/docs/changelog.md +930 -218
package/docs/examples.md +308 -1
package/docs/reference/classes/AlreadyExistsError.md +36 -36
package/docs/reference/classes/ArrayHelper.md +10 -44
package/docs/reference/classes/AsyncCache.md +13 -12
package/docs/reference/classes/Base32.md +4 -4
package/docs/reference/classes/Base58.md +3 -3
package/docs/reference/classes/Base64.md +4 -4
package/docs/reference/classes/Base64Url.md +3 -3
package/docs/reference/classes/BaseError.md +35 -35
package/docs/reference/classes/BitString.md +6 -6
package/docs/reference/classes/Coerce.md +11 -11
package/docs/reference/classes/Compression.md +3 -3
package/docs/reference/classes/ConflictError.md +36 -36
package/docs/reference/classes/Converter.md +18 -18
package/docs/reference/classes/EnvHelper.md +1 -1
package/docs/reference/classes/ErrorHelper.md +20 -10
package/docs/reference/classes/Factory.md +112 -18
package/docs/reference/classes/FilenameHelper.md +1 -1
package/docs/reference/classes/GeneralError.md +36 -36
package/docs/reference/classes/GuardError.md +36 -36
package/docs/reference/classes/Guards.md +33 -33
package/docs/reference/classes/HexHelper.md +6 -6
package/docs/reference/classes/I18n.md +14 -14
package/docs/reference/classes/Is.md +42 -42
package/docs/reference/classes/JsonHelper.md +10 -10
package/docs/reference/classes/Mutex.md +128 -0
package/docs/reference/classes/NotFoundError.md +36 -36
package/docs/reference/classes/NotImplementedError.md +35 -35
package/docs/reference/classes/NotSupportedError.md +36 -36
package/docs/reference/classes/NumberHelper.md +2 -2
package/docs/reference/classes/ObjectHelper.md +135 -73
package/docs/reference/classes/RandomHelper.md +8 -8
package/docs/reference/classes/SharedStore.md +3 -3
package/docs/reference/classes/StringHelper.md +45 -23
package/docs/reference/classes/Uint8ArrayHelper.md +1 -1
package/docs/reference/classes/UnauthorizedError.md +37 -37
package/docs/reference/classes/UnprocessableError.md +36 -36
package/docs/reference/classes/Url.md +8 -8
package/docs/reference/classes/Urn.md +24 -24
package/docs/reference/classes/Validation.md +25 -25
package/docs/reference/classes/ValidationError.md +35 -35
package/docs/reference/index.md +9 -0
package/docs/reference/interfaces/IComponent.md +40 -4
package/docs/reference/interfaces/IError.md +11 -11
package/docs/reference/interfaces/IHealth.md +55 -0
package/docs/reference/interfaces/II18nShared.md +4 -4
package/docs/reference/interfaces/IKeyValue.md +2 -2
package/docs/reference/interfaces/ILabelledValue.md +2 -2
package/docs/reference/interfaces/ILocale.md +2 -2
package/docs/reference/interfaces/ILocaleDictionary.md +1 -1
package/docs/reference/interfaces/ILocalesIndex.md +1 -1
package/docs/reference/interfaces/IMutexWorkerMessage.md +35 -0
package/docs/reference/interfaces/IPatchOperation.md +6 -6
package/docs/reference/interfaces/IUrlParts.md +9 -9
package/docs/reference/interfaces/IValidationFailure.md +4 -4
package/docs/reference/type-aliases/HealthStatus.md +5 -0
package/docs/reference/type-aliases/MutexMessageTypes.md +5 -0
package/docs/reference/type-aliases/SingleOccurrenceArray.md +15 -0
package/docs/reference/type-aliases/SingleOccurrenceArrayDepthHelper.md +19 -0
package/docs/reference/variables/CoerceType.md +10 -10
package/docs/reference/variables/CompressionType.md +2 -2
package/docs/reference/variables/HealthStatus.md +25 -0
package/docs/reference/variables/MutexMessageTypes.md +13 -0
package/locales/en.json +8 -1
package/package.json +6 -6
package/dist/es/models/objectOrArray.js.map +0 -1
/package/dist/es/{models → types}/objectOrArray.js +0 -0
/package/dist/types/{models → types}/objectOrArray.d.ts +0 -0

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

@@ -26,7 +26,7 @@ The source of the error.
 `string`
-The message as a code.
+The message as an i18n key.
 ##### notFoundId?
@@ -54,9 +54,9 @@ The cause of the error if we have wrapped another error.
 ## Properties
-### source?
+### source? {#source}
-> `optional` **source**: `string`
+> `optional` **source?**: `string`
 The source of the error.
@@ -66,9 +66,9 @@ The source of the error.
 ***
-### properties?
+### properties? {#properties}
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 Any additional information for the error.
@@ -82,9 +82,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.
@@ -94,7 +94,7 @@ The cause of the error.
 ***
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 > `readonly` `static` **CLASS\_NAME**: `string`
@@ -102,7 +102,7 @@ Runtime name for the class.
 ## Methods
-### fromError()
+### fromError() {#fromerror}
 > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
@@ -128,7 +128,7 @@ The new instance.
 ***
-### flatten()
+### flatten() {#flatten}
 > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
@@ -154,7 +154,7 @@ The list of all internal errors.
 ***
-### expand()
+### expand() {#expand}
 > `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
@@ -164,9 +164,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
@@ -180,7 +180,7 @@ The first level error.
 ***
-### isErrorName()
+### isErrorName() {#iserrorname}
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
@@ -196,9 +196,9 @@ The error to test.
 ##### name
-The name to check for.
+`string` \| `RegExp`
-`string` | `RegExp`
+The name to check for.
 #### Returns
@@ -212,7 +212,7 @@ True if the error has the name.
 ***
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
@@ -228,9 +228,9 @@ The error to test.
 ##### message
-The message to check for.
+`string` \| `RegExp`
-`string` | `RegExp`
+The message to check for.
 #### Returns
@@ -244,7 +244,7 @@ True if the error has the name.
 ***
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 > `static` **isErrorCode**(`error`, `code`): `boolean`
@@ -260,9 +260,9 @@ The error to test.
 ##### code
-The code to check for.
+`string` \| `RegExp`
-`string` | `RegExp`
+The code to check for.
 #### Returns
@@ -276,7 +276,7 @@ True if the error has the code.
 ***
-### someErrorName()
+### someErrorName() {#someerrorname}
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
@@ -292,9 +292,9 @@ The error to test.
 ##### name
-The name to check for.
+`string` \| `RegExp`
-`string` | `RegExp`
+The name to check for.
 #### Returns
@@ -308,7 +308,7 @@ True if the error has the name.
 ***
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
@@ -324,9 +324,9 @@ The error to test.
 ##### message
-The message to check for.
+`string` \| `RegExp`
-`string` | `RegExp`
+The message to check for.
 #### Returns
@@ -340,7 +340,7 @@ True if the error has the name.
 ***
-### someErrorClass()
+### someErrorClass() {#someerrorclass}
 > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
@@ -372,7 +372,7 @@ True if the error has the specific class.
 ***
-### someErrorCode()
+### someErrorCode() {#someerrorcode}
 > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
@@ -388,9 +388,9 @@ The error to test.
 ##### code
-The code to check for.
+`string` \| `RegExp`
-`string` | `RegExp`
+The code to check for.
 #### Returns
@@ -404,7 +404,7 @@ True if the error has the name.
 ***
-### isEmpty()
+### isEmpty() {#isempty}
 > `static` **isEmpty**(`err`): `boolean`
@@ -430,7 +430,7 @@ True if the error is empty.
 ***
-### isAggregateError()
+### isAggregateError() {#isaggregateerror}
 > `static` **isAggregateError**(`err`): `err is AggregateError`
@@ -456,7 +456,7 @@ True if the error is an aggregate error.
 ***
-### fromAggregate()
+### fromAggregate() {#fromaggregate}
 > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
@@ -488,7 +488,7 @@ The array of errors.
 ***
-### toJsonObject()
+### toJsonObject() {#tojsonobject}
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)

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

@@ -48,9 +48,9 @@ The cause of the error if we have wrapped another error.
 ## Properties
-### source?
+### source? {#source}
-> `optional` **source**: `string`
+> `optional` **source?**: `string`
 The source of the error.
@@ -60,9 +60,9 @@ The source of the error.
 ***
-### properties?
+### properties? {#properties}
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 Any additional information for the error.
@@ -76,9 +76,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.
@@ -88,7 +88,7 @@ The cause of the error.
 ***
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 > `readonly` `static` **CLASS\_NAME**: `string`
@@ -96,7 +96,7 @@ Runtime name for the class.
 ## Methods
-### fromError()
+### fromError() {#fromerror}
 > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
@@ -122,7 +122,7 @@ The new instance.
 ***
-### flatten()
+### flatten() {#flatten}
 > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
@@ -148,7 +148,7 @@ The list of all internal errors.
 ***
-### expand()
+### expand() {#expand}
 > `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
@@ -158,9 +158,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
@@ -174,7 +174,7 @@ The first level error.
 ***
-### isErrorName()
+### isErrorName() {#iserrorname}
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
@@ -190,9 +190,9 @@ The error to test.
 ##### name
-The name to check for.
+`string` \| `RegExp`
-`string` | `RegExp`
+The name to check for.
 #### Returns
@@ -206,7 +206,7 @@ True if the error has the name.
 ***
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
@@ -222,9 +222,9 @@ The error to test.
 ##### message
-The message to check for.
+`string` \| `RegExp`
-`string` | `RegExp`
+The message to check for.
 #### Returns
@@ -238,7 +238,7 @@ True if the error has the name.
 ***
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 > `static` **isErrorCode**(`error`, `code`): `boolean`
@@ -254,9 +254,9 @@ The error to test.
 ##### code
-The code to check for.
+`string` \| `RegExp`
-`string` | `RegExp`
+The code to check for.
 #### Returns
@@ -270,7 +270,7 @@ True if the error has the code.
 ***
-### someErrorName()
+### someErrorName() {#someerrorname}
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
@@ -286,9 +286,9 @@ The error to test.
 ##### name
-The name to check for.
+`string` \| `RegExp`
-`string` | `RegExp`
+The name to check for.
 #### Returns
@@ -302,7 +302,7 @@ True if the error has the name.
 ***
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
@@ -318,9 +318,9 @@ The error to test.
 ##### message
-The message to check for.
+`string` \| `RegExp`
-`string` | `RegExp`
+The message to check for.
 #### Returns
@@ -334,7 +334,7 @@ True if the error has the name.
 ***
-### someErrorClass()
+### someErrorClass() {#someerrorclass}
 > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
@@ -366,7 +366,7 @@ True if the error has the specific class.
 ***
-### someErrorCode()
+### someErrorCode() {#someerrorcode}
 > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
@@ -382,9 +382,9 @@ The error to test.
 ##### code
-The code to check for.
+`string` \| `RegExp`
-`string` | `RegExp`
+The code to check for.
 #### Returns
@@ -398,7 +398,7 @@ True if the error has the name.
 ***
-### isEmpty()
+### isEmpty() {#isempty}
 > `static` **isEmpty**(`err`): `boolean`
@@ -424,7 +424,7 @@ True if the error is empty.
 ***
-### isAggregateError()
+### isAggregateError() {#isaggregateerror}
 > `static` **isAggregateError**(`err`): `err is AggregateError`
@@ -450,7 +450,7 @@ True if the error is an aggregate error.
 ***
-### fromAggregate()
+### fromAggregate() {#fromaggregate}
 > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
@@ -482,7 +482,7 @@ The array of errors.
 ***
-### toJsonObject()
+### toJsonObject() {#tojsonobject}
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)